openstack/api-sig
Code Issues Proposed changes

Add links to errors-example.json

Browse Source 
They've been TODO for a long time. The provided links are
examples only, but include advice that services should publish
their own error code documentation.

Change-Id: I8e80160abc51ace34e8e286defc9ebe6a7847d54
Story: 1593321
Task: 22178
This commit is contained in:
Chris Dent 2018-06-27 13:31:58 +01:00
parent ff8fbbf3a9
commit 777732d9c4
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
guidelines/errors-example.json
View File

@ -9,7 +9,7 @@
"links": [
{
"rel": "help",
"href": "TODO(sdague): example href"
"href": "https://developer.openstack.org/api-ref/orchestration/errors/orchestration.create-failed"
}
]
},
@ -22,7 +22,7 @@
"links": [
{
"rel": "help",
"href": "TODO(sdague): example href"
"href": "https://developer.openstack.org/api-ref/compute/errors/compute.scheduler.no-valid-host-found"
}
]
}

5
guidelines/errors.rst
View File

@ -37,7 +37,10 @@ Errors JSON Example
.. note:: This example is completely contrived. This is not how Orchestration
or Compute responds with errors. It merely illustrates how a service might
chain together errors.
chain together errors. The example hrefs in the ``links`` are examples
only, but demonstrate that a service should be responsible for publishing
and maintaining the documentation associated with the error codes the
service produces.
Errors Documentation
--------------------