website: Document key sanitization

This commit is contained in:
Armon Dadgar 2014-12-08 19:49:23 -08:00 committed by Mitchell Hashimoto
parent ef57437a6e
commit c4de19c740
1 changed files with 3 additions and 1 deletions

View File

@ -72,7 +72,9 @@ The following attributes are exported:
* `id` - The ID of the artifact. This could be an AMI ID, GCE Image ID, etc.
* `file_url` - For artifacts that are binaries, this is a download path.
* `metadata_full` - Contains the full metadata of the artifact.
* `metadata_full` - Contains the full metadata of the artifact. The keys are sanitized
to replace any characters that are invalid in a resource name with a hypen.
For example, the "region.us-east-1" key will become "region-us-east-1".
* `version_real` - The matching version of the artifact
* `slug` - The artifact slug in Atlas