He Jie Xu 96700d724e Add version discover guideline for API microversions

This guidelines describes how the client can request the
available microversions from the server.

Change-Id: I96a5084e5c44f030c19ed31f123b90cd184174b7

2016-03-14 14:58:08 +08:00

1.1 KiB

Raw Blame History

Errors

Description

Errors are a crucial part of the developer experience when using an API. As developers learn the API they inevitably run into errors. The quality and consistency of the error messages returned to them will play a large part in how quickly they can learn the API, how they can be more effective with the API, and how much they enjoy using the API.

Errors JSON Schema

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in 2119.

errors-schema.json

Errors JSON Example

errors-example.json

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.

Errors Documentation

TODO(sdague): Expand on the vision behind Errors Documentation

1.1 KiB Raw Blame History