Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Metadata - Guideline 13 #52

Closed
cmheazel opened this issue Jan 29, 2021 · 1 comment
Closed

Metadata - Guideline 13 #52

cmheazel opened this issue Jan 29, 2021 · 1 comment

Comments

@cmheazel
Copy link
Collaborator

This guideline calls for metadata to be a part of the resource tree (a path element). In practice, we are associating metadata with resources though an association. Most notable, the service-meta and data-meta association types. This is a more flexible, and arguably more intuitive approach than that prescribed in Guideline 13.

@fterpstra
Copy link
Contributor

fterpstra commented Feb 5, 2021

The current guideline #13 is too strict, there are cases where explicitly putting meta-data in the resource path is confusing to the user/programmer. The guideline should be relaxed to state that you should provide meta-data. It should be there to help the client/user/programmer understand the API and its content. The metadata should be associated with the resource it describes. The service-meta and data-meta association types can be referenced as an example on how to do this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants