diff --git a/SUMMARY.md b/SUMMARY.md index 8a13c37..0dd063b 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -5,4 +5,6 @@ * [API First](core-principles/api-first.md) * [OpenAPI Specification](core-principles/openapi-specification.md) * [Apiary](core-principles/apiary.md) + * [Version Control System](core-principles/version-control-system.md) + * [Contract](core-principles/contract.md) diff --git a/core-principles/contract.md b/core-principles/contract.md new file mode 100644 index 0000000..8eeb7eb --- /dev/null +++ b/core-principles/contract.md @@ -0,0 +1,4 @@ +# Contract +Approved API Design, represented by its API Description, MUST represent the **contract** between API stakeholder, implementers and consumers. + +Any change to an API MUST be accompanied by a relevant change in the contract (API Description). \ No newline at end of file diff --git a/core-principles/version-control-system.md b/core-principles/version-control-system.md new file mode 100644 index 0000000..b483ae9 --- /dev/null +++ b/core-principles/version-control-system.md @@ -0,0 +1,2 @@ +# Version Control System +Every API description SHOULD be stored in an Version Control System (Bitbucket, GitHub). Where possible the API description SHOULD stored in the **same** repository as the API implementation. \ No newline at end of file