summaryrefslogtreecommitdiffstats
path: root/docs/guide
diff options
context:
space:
mode:
authorYogeshwar Srikrishnan <yoga80@yahoo.com>2011-05-20 15:35:31 -0500
committerYogeshwar Srikrishnan <yoga80@yahoo.com>2011-05-20 15:35:31 -0500
commitd2fd1667a9dc50917f556cd4f04d2bf2d975ec4d (patch)
treefe8294cfcff4cdbd604357c6bbf6ae9dd5075a74 /docs/guide
parent17a62b378d721bdf28fe1b21cdb25803cb807864 (diff)
downloadkeystone-d2fd1667a9dc50917f556cd4f04d2bf2d975ec4d.tar.gz
keystone-d2fd1667a9dc50917f556cd4f04d2bf2d975ec4d.tar.xz
keystone-d2fd1667a9dc50917f556cd4f04d2bf2d975ec4d.zip
Adding xsds to support roles and baseurls
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/src/docbkx/xsd/baseURLs.xsd186
-rw-r--r--docs/guide/src/docbkx/xsd/roles.xsd95
2 files changed, 281 insertions, 0 deletions
diff --git a/docs/guide/src/docbkx/xsd/baseURLs.xsd b/docs/guide/src/docbkx/xsd/baseURLs.xsd
new file mode 100644
index 00000000..54869140
--- /dev/null
+++ b/docs/guide/src/docbkx/xsd/baseURLs.xsd
@@ -0,0 +1,186 @@
+<?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/identity/api/v2.0"
+ xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+ targetNamespace="http://docs.openstack.org/identity/api/v2.0"
+>
+ <element name="baseURLs" type="idm:BaseURLList">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ A list of base URLs.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </element>
+
+ <element name="baseURL" type="idm:BaseURL">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ A base URLs.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </element>
+ <element name="baseURLRef" type="idm:BaseURLRef">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ A refrence to a base URL.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </element>
+ <element name="baseURLRefs" type="idm:BaseURLRefList">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ A list of base URL refrences.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </element>
+
+ <!-- Complex Types -->
+ <complexType name="BaseURL">
+ <attribute name="id" type="xsd:int" use="required">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ An ID uniquely identifying the base URL.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </attribute>
+ <attribute name="serviceName" type="xsd:string" use="required">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ The base URL's service name.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </attribute>
+ <attribute name="region" type="xsd:string" use="optional">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ The URL's region.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </attribute>
+ <attribute name="publicURL" type="xsd:anyURI" use="required">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ The public base URL.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </attribute>
+ <attribute name="internalURL" type="xsd:anyURI" use="optional">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ The internal version of the public base URL.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </attribute>
+ <attribute name="adminURL" type="xsd:anyURI" use="optional">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ The admin base URL.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </attribute>
+ <attribute name="default" type="xsd:boolean" default="false" use="optional">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ If true the baseURL is automatically added to
+ new accounts.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </attribute>
+ <attribute name="enabled" type="xsd:boolean" default="true" use="optional">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ True if the Base URL is enabled (active).
+ A Base URL cannot be added if it's disabled or inactive (false).
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </attribute>
+ </complexType>
+
+ <complexType name="BaseURLRef">
+ <attribute name="id" type="xsd:int" use="required">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ An ID uniquely identifying the base URL.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </attribute>
+ <attribute name="href" type="xsd:anyURI" use="optional">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ A hyperlink refrence to the base URL.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </attribute>
+ </complexType>
+
+ <complexType name="BaseURLList">
+ <sequence>
+ <element name="baseURL" type="idm:BaseURL" minOccurs="0" maxOccurs="unbounded"/>
+ </sequence>
+ </complexType>
+
+ <complexType name="BaseURLRefList">
+ <sequence>
+ <element name="baseURLRef" type="idm:BaseURLRef" minOccurs="0" maxOccurs="unbounded"/>
+ </sequence>
+ </complexType>
+</schema>
diff --git a/docs/guide/src/docbkx/xsd/roles.xsd b/docs/guide/src/docbkx/xsd/roles.xsd
new file mode 100644
index 00000000..31e40ae5
--- /dev/null
+++ b/docs/guide/src/docbkx/xsd/roles.xsd
@@ -0,0 +1,95 @@
+<?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/identity/api/v2.0"
+ xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+ targetNamespace="http://docs.openstack.org/identity/api/v2.0"
+>
+ <!-- Elements -->
+ <element name="roles" type="idm:RoleList" >
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ A list of roles.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </element>
+
+ <element name="role" type="idm:Role" >
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ A role.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </element>
+
+
+ <element name="rolerefs" type="idm:RoleRefList" >
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ A list of roles refs.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </element>
+
+ <element name="roleref" type="idm:RoleRef" >
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ A role reference.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </element>
+
+
+ <!-- Complex Types -->
+ <complexType name="Role">
+ <attribute name="id" type="xsd:string" use="required"/>
+ <attribute name="service" type="xsd:string" use="optional"/>
+ </complexType>
+
+ <complexType name="RoleRef">
+ <attribute name="id" type="xsd:int" use="required"/>
+ <attribute name="tenantId" type="xsd:string" use="required" />
+ <attribute name="href" type="xsd:anyURI" use="optional">
+ <annotation>
+ <xsd:documentation
+ xml:lang="EN"
+ xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ A hyperlink refrence to the role URL.
+ </p>
+ </xsd:documentation>
+ </annotation>
+ </attribute>
+ </complexType>
+
+ <complexType name="RoleList">
+ <sequence>
+ <element name="role" type="idm:Role" minOccurs="0" maxOccurs="unbounded"/>
+ </sequence>
+ </complexType>
+
+ <complexType name="RoleRefList">
+ <sequence>
+ <element name="role" type="idm:RoleRef" minOccurs="0" maxOccurs="unbounded"/>
+ </sequence>
+ </complexType>
+</schema> \ No newline at end of file