diff --git a/guidelines/errors-example.json b/guidelines/errors-example.json index 77b01e1..b88acfc 100644 --- a/guidelines/errors-example.json +++ b/guidelines/errors-example.json @@ -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" } ] } diff --git a/guidelines/errors.rst b/guidelines/errors.rst index 0c485d3..f32a263 100644 --- a/guidelines/errors.rst +++ b/guidelines/errors.rst @@ -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 --------------------