Clarify key usage when releasing attributes#5
Open
drazzilb91 wants to merge 1 commit into
Open
Conversation
bellebethcooper
approved these changes
Jul 2, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request clarifies the key to use when releasing attributes in the Exist API. The documentation previously mentioned using the
https://exist.io/api/2/attributes/release/endpoint, but it didn't specify that thenamekey should be used instead oftemplate. This update ensures that developers have the correct information when releasing attributes.Earlier in the documentation, when acquiring attributes, both
nameandtemplateare mentioned as valid keys to use. The documentation states:The documentation also indicates that releasing attributes uses the same format as acquiring attributes. This is incorrect, as using
templatewill result in the following failed response from the API:{ "success": [], "failed": [ { "template": "pages_read", "manual": "false", "error": "Object at index 0 is missing field 'name'", "error_code": "missing_field" } ] }A wording change in the documentation clarifies that regardless of how the attribute was acquired, the
namekey is required when releasing attributes.