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

Resource naming cardinality #63

Open
oyron opened this issue Sep 26, 2019 · 0 comments
Open

Resource naming cardinality #63

oyron opened this issue Sep 26, 2019 · 0 comments
Labels
enhancement New feature or request

Comments

@oyron
Copy link
Collaborator

oyron commented Sep 26, 2019

@Qif-Equinor and others have proposed to include guidelines on resource naming cardinality in the API Strategy. From Qiang's PR:

Resource naming

A resource name should clearly indicate the cardinality by using plural nouns for collections, and an instance id for a member of that collection. For example, to get info on well 1234:

GET .../wells/1234

If a relation can only exist within another resource, then append the sub resources to the path. For example: since a well can have multiple well logs, the URL to get a ROHB log for 1234 would appear as follows:

GET .../wells/1234/logs/rohb
```https://github.com/Qif-Equinor/api-strategy.git
@oyron oyron added the enhancement New feature or request label Sep 26, 2019
@oyron oyron modified the milestone: v2 Sep 26, 2019
@oyron oyron mentioned this issue Sep 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant