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:11:27 +00:00
parent 1b0b43ebc8
commit 403c402efe
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
core-principles/versioning.md
View File

@@ -15,10 +15,10 @@ Any change to:
MUST follow the [Rules for Extending](core-principles/rules-for-extending.md).
## No URI Versioning
A change SHALL NOT affect **existing** resource identifiers (name / URI).
A change SHALL NOT affect **existing** resource identifiers (name / URI). Resource identifier MUST NOT contain semantic versioning to convey a version of resource or its representation format.
#### Example
Adding a new action to existing resource with identifier `/greeting` doesn't change its identifier to `/v2/greeting`.
Adding a new action to existing resource with identifier `/greeting` doesn't change its identifier to `/v2/greeting` (or `/greeting-with-new-action` etc.).
## 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.