diff options
| author | Jorge L. Williams <jorge.williams@rackspace.com> | 2011-04-15 01:00:11 -0500 |
|---|---|---|
| committer | Jorge L. Williams <jorge.williams@rackspace.com> | 2011-04-15 01:00:20 -0500 |
| commit | 0a7d594d4e9bc59450e79a7463cb8e41e8e4773d (patch) | |
| tree | f951f60308ae5a9f9f57f18b30aae6c7f34a127f | |
| parent | 673f574ae2f232c5111f2619b0466174afddf247 (diff) | |
| download | keystone-0a7d594d4e9bc59450e79a7463cb8e41e8e4773d.tar.gz keystone-0a7d594d4e9bc59450e79a7463cb8e41e8e4773d.tar.xz keystone-0a7d594d4e9bc59450e79a7463cb8e41e8e4773d.zip | |
Added faults.
| -rw-r--r-- | docs/guide/src/docbkx/xsd/api.xsd | 1 | ||||
| -rw-r--r-- | docs/guide/src/docbkx/xsd/fault.xsd | 135 |
2 files changed, 136 insertions, 0 deletions
diff --git a/docs/guide/src/docbkx/xsd/api.xsd b/docs/guide/src/docbkx/xsd/api.xsd index 088158d0..eaa11c17 100644 --- a/docs/guide/src/docbkx/xsd/api.xsd +++ b/docs/guide/src/docbkx/xsd/api.xsd @@ -10,4 +10,5 @@ > <include schemaLocation="token.xsd"/> <include schemaLocation="tenant.xsd"/> + <include schemaLocation="fault.xsd"/> </schema> diff --git a/docs/guide/src/docbkx/xsd/fault.xsd b/docs/guide/src/docbkx/xsd/fault.xsd new file mode 100644 index 00000000..8701b9f7 --- /dev/null +++ b/docs/guide/src/docbkx/xsd/fault.xsd @@ -0,0 +1,135 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<schema + elementFormDefault="qualified" + attributeFormDefault="unqualified" + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:idm="http://docs.openstack.org/idm/api/v1.0" + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + targetNamespace="http://docs.openstack.org/idm/api/v1.0" +> + <!-- Fault Elements --> + <element name="idmFault" type="idm:IDMFault"/> + <element name="serviceUnavailable" type="idm:ServiceUnavailableFault"/> + <element name="badRequest" type="idm:BadRequestFault"/> + <element name="unauthorized" type="idm:UnauthorizedFault"/> + <element name="overLimit" type="idm:OverLimitFault"/> + <element name="userDisabled" type="idm:UserDisabledFault"/> + <element name="forbidden" type="idm:ForbiddenFault"/> + <element name="itemNotFound" type="idm:ItemNotFoundFault"/> + <element name="tenantConflict" type="idm:TenantConflictFault"/> + + <!-- Fault Types --> + <complexType name="IDMFault"> + <sequence> + <element name="message" type="xsd:string"> + <annotation> + <xsd:documentation + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml"> + <p> + A human readable message that is appropriate for display + to the end user. + </p> + </xsd:documentation> + </annotation> + </element> + <element name="details" type="xsd:string" minOccurs="0"> + <annotation> + <xsd:documentation + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml"> + <p> + The optional <details> element may contain useful + information for tracking down errors (e.g a stack + trace). This information may or may not be appropriate + for display to an end user. + </p> + </xsd:documentation> + </annotation> + </element> + <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" /> + </sequence> + <attribute name="code" type="xsd:int" use="required"> + <annotation> + <xsd:documentation + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml"> + <p> + The HTTP status code associated with the current fault. + </p> + </xsd:documentation> + </annotation> + </attribute> + <anyAttribute namespace="##other" processContents="lax"/> + </complexType> + + <complexType name="ServiceUnavailableFault"> + <complexContent> + <extension base="idm:IDMFault"> + </extension> + </complexContent> + </complexType> + + <complexType name="BadRequestFault"> + <complexContent> + <extension base="idm:IDMFault"> + </extension> + </complexContent> + </complexType> + + <complexType name="UnauthorizedFault"> + <complexContent> + <extension base="idm:IDMFault"> + </extension> + </complexContent> + </complexType> + + <complexType name="UserDisabledFault"> + <complexContent> + <extension base="idm:IDMFault"> + </extension> + </complexContent> + </complexType> + + <complexType name="ForbiddenFault"> + <complexContent> + <extension base="idm:IDMFault"> + </extension> + </complexContent> + </complexType> + + <complexType name="ItemNotFoundFault"> + <complexContent> + <extension base="idm:IDMFault"> + </extension> + </complexContent> + </complexType> + + <complexType name="TenantConflictFault"> + <complexContent> + <extension base="idm:IDMFault"> + </extension> + </complexContent> + </complexType> + + <complexType name="OverLimitFault"> + <complexContent> + <extension base="idm:IDMFault"> + <attribute name="retryAt" type="xsd:dateTime" use="optional"> + <annotation> + <xsd:documentation + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml"> + <p> + An optional dateTime denoting when an operation should + be retried. + </p> + </xsd:documentation> + </annotation> + </attribute> + </extension> + </complexContent> + </complexType> + +</schema> |