openstack/api-site
Code Issues Proposed changes
api-site/api-ref/source/image/v2/schemas-metadefs-v2.inc
Anne Gentle ac4cc65cb5 Adds migrated RST + YAML files from WADL 
Contains .inc files which have all the contents of the .rst files
but are grouped together for easier editing.
Contains parameters.yaml, which has all parameters in one file.
Contains request and response samples (JSON and XML) that are
pointed to from the .inc files.

Change-Id: I42d5451300f95774a3ec4df66bc95cb36795844d
2016-05-02 17:42:49 -05:00

351 lines
6.9 KiB
ReStructuredText
Raw Blame History

.. -*- rst -*-
=======================================================================================================================================================
Metadata definition schemas (schemas, metadefs, namespace, namespaces, object, objects, property, properties, tag, tags, resource_type, resource_types)
=======================================================================================================================================================
Gets a JSON-schema document that represents a metadata definition
entity.
Show metadata definition namespaces schema
==========================================
.. rest_method:: GET /v2/schemas/metadefs/namespaces
(Since API v2.1) Shows a JSON schema document that represents a metadata definition namespaces entity.
A namespaces entity is a container for namespace entities.
The following schema document is an example. The authoritative
response is the actual response to the API call.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
Response Example
----------------
.. literalinclude:: ../samples/schema-metadef-namespaces-list-response.json
:language: javascript
Show metadata definition property schema
========================================
.. rest_method:: GET /v2/schemas/metadefs/property
(Since API v2.1) Shows a JSON schema document that represents a metadata definition property entity.
The following schema document is an example. The authoritative
response is the actual response to the API call.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
Response Example
----------------
.. literalinclude:: ../samples/schema-metadef-property-show-response.json
:language: javascript
Show metadata definition object schema
======================================
.. rest_method:: GET /v2/schemas/metadefs/object
(Since API v2.1) Shows a JSON schema document that represents a metadata definition object entity.
The following schema document is an example. The authoritative
response is the actual response to the API call.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
Response Example
----------------
.. literalinclude:: ../samples/schema-metadef-object-show-response.json
:language: javascript
Show metadata definition namespace resource type association schema
===================================================================
.. rest_method:: GET /v2/schemas/metadefs/resource_type
(Since API v2.1) Shows a JSON schema document that represents a metadata definition namespace resource type association entity.
The following schema document is an example. The authoritative
response is the actual response to the API call.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
Response Example
----------------
.. literalinclude:: ../samples/schema-metadef-resource-type-association-show-response.json
:language: javascript
Show metadata definition tags schema
====================================
.. rest_method:: GET /v2/schemas/metadefs/tags
(Since API v2.1) Shows a JSON schema document that represents a metadata definition tags entity.
A tags entity is a container for tag entities.
The following schema document is an example. The authoritative
response is the actual response to the API call.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
Response Example
----------------
.. literalinclude:: ../samples/schema-metadef-tags-list-response.json
:language: javascript
Show metadata definition properties schema
==========================================
.. rest_method:: GET /v2/schemas/metadefs/properties
(Since API v2.1) Shows a JSON schema document that represents a metadata definition properties entity.
A properties entity is a container for property entities.
The following schema document is an example. The authoritative
response is the actual response to the API call.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
Response Example
----------------
.. literalinclude:: ../samples/schema-metadef-properties-list-response.json
:language: javascript
Show metadata definition namespace resource type associations schema
====================================================================
.. rest_method:: GET /v2/schemas/metadefs/resource_types
(Since API v2.1) Shows a JSON schema document that represents a metadata definition namespace resource type associations entity.
A resource type associations entity is a container for resource
type association entities.
The following schema document is an example. The authoritative
response is the actual response to the API call.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
Response Example
----------------
.. literalinclude:: ../samples/schema-metadef-resource-type-associations-list-response.json
:language: javascript
Show metadata definition tag schema
===================================
.. rest_method:: GET /v2/schemas/metadefs/tag
(Since API v2.1) Shows a JSON schema document that represents a metadata definition tag entity.
The following schema document is an example. The authoritative
response is the actual response to the API call.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
Response Example
----------------
.. literalinclude:: ../samples/schema-metadef-tag-show-response.json
:language: javascript
Show metadata definition namespace schema
=========================================
.. rest_method:: GET /v2/schemas/metadefs/namespace
(Since API v2.1) Shows a JSON schema document that represents a metadata definition namespace entity.
The following schema document is an example. The authoritative
response is the actual response to the API call.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
Response Example
----------------
.. literalinclude:: ../samples/schema-metadef-namespace-show-response.json
:language: javascript
Show metadata definition objects schema
=======================================
.. rest_method:: GET /v2/schemas/metadefs/objects
(Since API v2.1) Shows a JSON schema document that represents a metadata definition objects entity.
An objects entity is a container for object entities.
The following schema document is an example. The authoritative
response is the actual response to the API call.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
Response Example
----------------
.. literalinclude:: ../samples/schema-metadef-objects-list-response.json
:language: javascript
View Git Blame Copy Permalink