openstack
/
api-sig
Code Issues Proposed changes

Merge "Add links to errors-example.json"

This commit is contained in:
Zuul 2018-07-26 16:28:50 +00:00 committed by Gerrit Code Review
parent 767ea9f5f6 777732d9c4
commit 8563aebd2a
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

@ -43,7 +43,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
--------------------