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 10:01:21 +00:00
parent 41b49ca77e
commit ffcab7661c
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
core-principles/versioning.md
View File

@@ -14,18 +14,20 @@ Any change to:
MUST follow the [Rules for Extending](core-principles/rules-for-extending.md).
### No URI Versioning
## No URI Versioning
A change SHALL NOT affect **existing** resource identifiers (name / URI).
### Backward-incompatible Change
A change that can't follow the [Rules for Extending](core-principles/rules-for-extending.md) MUST result into a new resource variant
#### Example
Adding a new action to existing resource with identifier `/greeting` doesn't change its identifier to `/v2/greeting`.
## Backward-incompatible Change
A change to _resource identifier_, _resource metadata_, _resource actions_ and _resource relations_, that can't follow the [Rules for Extending](core-principles/rules-for-extending.md) MUST result into a **new resource variant**. Existing resource variant MUST be preserved.
A change to _representation format_ SHOULD NOT result into a new resource variant.
### 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.
A change to a representation format MUST follow the [Rules for Extending](core-principles/rules-for-extending.md).
If the change can't follow the Rules for Extending the representation format media type MUST be changed. If the media type has been changed the previous media type MUST be available via [Content Negotiation](core-principles/content-negotiation.md).
#### Example