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/rules-for-extending.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-02-14 14:44:44 +00:00
parent 2519b06f07
commit e16b69d869
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
core-principles/minimal-api-surface.md
View File

@@ -1,2 +1,2 @@
# Minimal API Surface
Every API design MUST aim for a minimal API surface without sacrificing on product requirements. API design SHOULD NOT include unnecessary resources, relations, actions or data. API design SHOULD NOT add functionality until deemed necessary ([YAGNI principle](https://martinfowler.com/bliki/Yagni.html)).
Every API design **MUST** aim for a minimal API surface without sacrificing on product requirements. API design **SHOULD NOT** include unnecessary resources, relations, actions or data. API design **SHOULD NOT** add functionality until deemed necessary ([YAGNI principle](https://martinfowler.com/bliki/Yagni.html)).

4
core-principles/rules-for-extending.md
View File

@@ -1,7 +1,7 @@
# Rules for Extending
Any modification to an existing API MUST avoid breaking changes and MUST maintain backward compatibility.
Any modification to an existing API **MUST** avoid breaking changes and MUST maintain backward compatibility.
In particular, any change to an API MUST follow the following Rules for Extending:
In particular, any change to an API **MUST** follow the following **Rules for Extending**:
1. **You MUST NOT take anything away** (related: [Minimal Surface Principle](core-principles/minimal-api-surface.md)
, [Robustness Principle](core-principles/robustness.md))