diff --git a/SUMMARY.md b/SUMMARY.md index 963db5a..8999725 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -17,12 +17,12 @@ * [Changes and Versioning](core-principles/versioning.md) * [Protocol](protocol/README.md) * [HTTP](protocol/http.md) - * [Know your HTTP](protocol/know-your-http.md) * [TLS](protocol/tls.md) - * [Content Negotiation ](protocol/content-negotiation.md) + * [Know your HTTP](protocol/know-your-http.md) * [Separate Concerns](protocol/separate-concerns.md) - * [Use Appropriate Methods](protocol/use-appropriate-methods.md) - * [Use Appropriate Status Codes](protocol/use-appropriate-status-codes.md) + * [Content Negotiation ](protocol/content-negotiation.md) + * [Request Methods](protocol/use-appropriate-methods.md) + * [Status Codes](protocol/use-appropriate-status-codes.md) * Caching * [Miscellaneous](miscellaneous.md) diff --git a/core-principles/implementation-maturity.md b/core-principles/implementation-maturity.md index d28c464..64697aa 100644 --- a/core-principles/implementation-maturity.md +++ b/core-principles/implementation-maturity.md @@ -1,7 +1,7 @@ # Implementation Maturity -Every API design using the HTTP(S) protocol MUST use the appropriate **HTTP Request Method semantics** ([Richardson Maturity Model Level 2](https://martinfowler.com/articles/richardsonMaturityModel.html#level2)) to implement any action afforded by a resource. +Every API design using the HTTP(S) protocol MUST use the appropriate **HTTP Request Method** ([Richardson Maturity Model Level 2](https://martinfowler.com/articles/richardsonMaturityModel.html#level2)) to implement an action afforded by a resource. -An API design implementation SHOULD include **hypermedia controls**–HATEOAS–([Richardson Maturity Model Level 3](https://martinfowler.com/articles/richardsonMaturityModel.html#level3)). +An API design implementation SHOULD include **hypermedia controls** (HATEOAS) ([Richardson Maturity Model Level 3](https://martinfowler.com/articles/richardsonMaturityModel.html#level3)). (TODO: see HTTP Verbs Appendix) diff --git a/core-principles/rules-for-extending.md b/core-principles/rules-for-extending.md index 4af97d9..b913058 100644 --- a/core-principles/rules-for-extending.md +++ b/core-principles/rules-for-extending.md @@ -1,7 +1,7 @@ # Rules for Extending Any modification to an existing API design MUST avoid breaking changes and MUST maintain backward compatibility. -In particular any change to an API design MUST follow the following Rules for Extending: +In particular, any change to an API design 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)) diff --git a/protocol/use-appropriate-methods.md b/protocol/use-appropriate-methods.md index e69de29..769cb81 100644 --- a/protocol/use-appropriate-methods.md +++ b/protocol/use-appropriate-methods.md @@ -0,0 +1 @@ +# Use Appropriate Request Methods diff --git a/protocol/use-appropriate-status-codes.md b/protocol/use-appropriate-status-codes.md index e69de29..3454b29 100644 --- a/protocol/use-appropriate-status-codes.md +++ b/protocol/use-appropriate-status-codes.md @@ -0,0 +1 @@ +# Use Appropriate Status Codes