diff --git a/README.md b/README.md index 7d12ea8..292a4f3 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ conventions, and best practice recommendations. Interested in contributing to the API conversations? Simply clone this repository and follow the [OpenStack code and review submission -processes](processes). +processes](https://wiki.openstack.org/wiki/How_To_Contribute). Guidance -------- @@ -20,5 +20,3 @@ specific issue: * [API Discoverability](discoverability.md) * [Compatibility](compatibility.md) * [API Extensions](extensions.md) - -[processes]: https://wiki.openstack.org/wiki/How_To_Contribute diff --git a/compatibility.md b/compatibility.md index 4236b09..3907d48 100644 --- a/compatibility.md +++ b/compatibility.md @@ -4,12 +4,10 @@ Compatibility This topic document serves to provide guidance on how to handle proposed changes to a public REST API. -See also the topic document on [API discoverability](discoverability). +See also the topic document on [API discoverability](discoverability.md). Guidance -------- **TODO** Take pieces from https://wiki.openstack.org/wiki/APIChangeGuidelines and add them to this topic document, one at a time, in separate patches. - -[discoverability]: discoverability.md diff --git a/discoverability.md b/discoverability.md index 810eefa..77cbaa5 100644 --- a/discoverability.md +++ b/discoverability.md @@ -4,12 +4,10 @@ API Discoverability This topic document serves to provide guidance on how to have a public REST API expose the URIs and resources to end users in a machine-readable way. -See also the topic document on [compatibility](compatibility). +See also the topic document on [compatibility](compatibility.md). Guidance -------- **TODO** Add sections that describe a best practice for API discoverability, possibly using JSON-Home, JSONSchema documents, and JSON-HAL. - -[compatibility]: compatibility.md diff --git a/extensions.md b/extensions.md index a383612..91258a7 100644 --- a/extensions.md +++ b/extensions.md @@ -3,7 +3,7 @@ API Extensions This topic document serves to provide guidance on the topic of API extensions. -See also the topic document on [discoverability](discoverability). +See also the topic document on [discoverability](discoverability.md). Guidance -------- @@ -15,5 +15,3 @@ OpenStack projects. **TODO** Add a patch that makes a proposal about whether or not to recommend use of API extensions. - -[discoverability]: discoverability.md diff --git a/http.md b/http.md index 84d86fe..535aa23 100644 --- a/http.md +++ b/http.md @@ -6,7 +6,7 @@ by OpenStack APIs as well as what HTTP methods should be supported and preferred. If something is not covered by this document, projects should follow the -guidelines in [RFC 2616](rfc2616). +guidelines in [RFC 2616](https://tools.ietf.org/html/rfc2616). HTTP Response Codes ------------------- @@ -47,5 +47,3 @@ Conveying error/fault information to the end user **TODO**: We should have a section here that describes the recommended way of transmitting error/fault information back to the user, including any guidelines on the payload in the response body. - -[rfc2616]: https://tools.ietf.org/html/rfc2616 diff --git a/terms.md b/terms.md index 06137bf..dad121b 100644 --- a/terms.md +++ b/terms.md @@ -1,7 +1,7 @@ Terms ===== -As Phil Karlson [once said](hardthings): +As Phil Karlson [once said](http://martinfowler.com/bliki/TwoHardThings.html): > There are only two hard things in Computer Science: cache invalidation and > naming things. @@ -24,6 +24,3 @@ made regarding certain terms, and attempts to succinctly define each term. compute purposes. The older term ***instance*** that is also by Amazon Web Services EC2 API to describe a virtual machine, should *not* be used in OpenStack REST APIs. - -[processes]: https://wiki.openstack.org/wiki/How_To_Contribute -[hardthings]: http://martinfowler.com/bliki/TwoHardThings.html