openstack/api-sig
Code Issues Proposed changes

Fix links

Browse Source
This commit is contained in:
Jay Pipes 2014-10-13 21:59:04 -04:00
parent 107d18cdb1
commit bead79f947
6 changed files with 6 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -7,7 +7,7 @@ conventions, and best practice recommendations.
Interested in contributing to the API conversations? Simply clone this Interested in contributing to the API conversations? Simply clone this
repository and follow the [OpenStack code and review submission repository and follow the [OpenStack code and review submission
processes](processes). processes](https://wiki.openstack.org/wiki/How_To_Contribute).
Guidance Guidance
-------- --------
@ -20,5 +20,3 @@ specific issue:
* [API Discoverability](discoverability.md) * [API Discoverability](discoverability.md)
* [Compatibility](compatibility.md) * [Compatibility](compatibility.md)
* [API Extensions](extensions.md) * [API Extensions](extensions.md)
[processes]: https://wiki.openstack.org/wiki/How_To_Contribute

4
compatibility.md
View File

@ -4,12 +4,10 @@ Compatibility
This topic document serves to provide guidance on how to handle proposed This topic document serves to provide guidance on how to handle proposed
changes to a public REST API. 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 Guidance
-------- --------
**TODO** Take pieces from https://wiki.openstack.org/wiki/APIChangeGuidelines **TODO** Take pieces from https://wiki.openstack.org/wiki/APIChangeGuidelines
and add them to this topic document, one at a time, in separate patches. and add them to this topic document, one at a time, in separate patches.
[discoverability]: discoverability.md

4
discoverability.md
View File

@ -4,12 +4,10 @@ API Discoverability
This topic document serves to provide guidance on how to have a public REST 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. 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 Guidance
-------- --------
**TODO** Add sections that describe a best practice for API discoverability, **TODO** Add sections that describe a best practice for API discoverability,
possibly using JSON-Home, JSONSchema documents, and JSON-HAL. possibly using JSON-Home, JSONSchema documents, and JSON-HAL.
[compatibility]: compatibility.md

4
extensions.md
View File

@ -3,7 +3,7 @@ API Extensions
This topic document serves to provide guidance on the topic of 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 Guidance
-------- --------
@ -15,5 +15,3 @@ OpenStack projects.
**TODO** Add a patch that makes a proposal about whether or not to recommend **TODO** Add a patch that makes a proposal about whether or not to recommend
use of API extensions. use of API extensions.
[discoverability]: discoverability.md

4
http.md
View File

@ -6,7 +6,7 @@ by OpenStack APIs as well as what HTTP methods should be supported and
preferred. preferred.
If something is not covered by this document, projects should follow the 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 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 **TODO**: We should have a section here that describes the recommended way of
transmitting error/fault information back to the user, including any guidelines transmitting error/fault information back to the user, including any guidelines
on the payload in the response body. on the payload in the response body.
[rfc2616]: https://tools.ietf.org/html/rfc2616

5
terms.md
View File

@ -1,7 +1,7 @@
Terms 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 > There are only two hard things in Computer Science: cache invalidation and
> naming things. > 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 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 Services EC2 API to describe a virtual machine, should *not* be used in
OpenStack REST APIs. OpenStack REST APIs.
[processes]: https://wiki.openstack.org/wiki/How_To_Contribute
[hardthings]: http://martinfowler.com/bliki/TwoHardThings.html