Skip to content

GitLab

rest api standards · Changes

Page history
rcabral created page: rest api standards authored by Rene Cabral's avatar Rene Cabral
Hide whitespace changes
Inline Side-by-side
rest-api-standards.markdown
View page @ be455f41
...@@ -7,7 +7,6 @@ ...@@ -7,7 +7,6 @@
- All URL paths must be dashed and lowercase. - All URL paths must be dashed and lowercase.
- All URL parameters (POST, GET, etc) must be underscored and lowercase: `snake_case`. - All URL parameters (POST, GET, etc) must be underscored and lowercase: `snake_case`.
- All entities must have a common schema with a minimum set of properties. - All entities must have a common schema with a minimum set of properties.
- Extra properties can be requested using the following notation: - Extra properties can be requested using the following notation: `resource-endpoint:(extra-property1, extra-property2)`
- `resource-endpoint:(extra-property1, extra-property2)`
- Extra properties can be sub-collections, relationships etc of the main resource. - Extra properties can be sub-collections, relationships etc of the main resource.