Merge "Add links to errors-example.json"
This commit is contained in:
commit
8563aebd2a
guidelines
@ -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"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
@ -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
|
||||
--------------------
|
||||
|
Loading…
x
Reference in New Issue
Block a user