Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates core-principles/versioning.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-01-31 11:03:22 +00:00
parent ffcab7661c
commit bf027d291b
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
core-principles/versioning.md
View File

@@ -25,6 +25,9 @@ A change to _resource identifier_, _resource metadata_, _resource actions_ and _
A change to _representation format_ SHOULD NOT result into a new resource variant.
#### Example
Currently optional URI Query parameter `first` on an existing resource `/greeting?first=John&last=Appleseed` needs to be made required. Since this change violates the 3rd rule of extending and could break existing clients a new variant of the resource is created with different URI `/named-greeting?first=John&last=Appleseed`.
### Representation Format Change
> A representation format is the serialization format (media type) used in request and response bodies and typically it represents a resource or its part, possibly with additional hypermedia controls.