Difference between revisions of "Manila/design/manila-liberty-consistency-groups/api-schema"
Alex Meade (talk | contribs) m |
Alex Meade (talk | contribs) m |
||
| Line 1: | Line 1: | ||
| − | = | + | = Resource schemas= |
== Simple CG == | == Simple CG == | ||
| Line 71: | Line 71: | ||
"required": ["id", "name", "description", "created_at", "status", "project_id", "host"] | "required": ["id", "name", "description", "created_at", "status", "project_id", "host"] | ||
} | } | ||
| − | |||
| − | |||
= Request schemas = | = Request schemas = | ||
Revision as of 14:51, 29 July 2015
Contents
Resource schemas
Simple CG
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Consistency Group (CG)",
"description": "A resource representing a group of shares that can be snapshotted in unison",
"type": "object",
"properties": {
"id": {
"description": "The unique identifier for a product",
"type": "integer"
},
"name": {
"description": "A non-unique name for a CG",
"type": "string"
},
},
"required": ["id", "name"]
}
Detailed CG
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Consistency Group (CG)",
"description": "A resource representing a group of shares that can be snapshotted in unison",
"type": "object",
"properties": {
"id": {
"description": "The unique identifier for a product",
"type": "integer",
'pattern': ('^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}'
'-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$'),
},
"name": {
"description": "A non-unique name for a CG",
"type": "string",
'maxLength': 255,
},
"description": {
"description": "A short description of the CG",
"type": "string"
},
"created_at": {
"description": "The time at which the CG was created",
"type": "string"
},
"status": {
"description": "Status of the CG",
"type": "string",
"enum": ["ACTIVE", "ERROR"]
},
"project_id": {
"description": "The owner of the CG",
"type": "string"
},
"host": {
"description": "The backend where the CG lives",
"type": "string"
},
"source_cgsnapshot_id": {
"description": "The uuid of the cgsnapshot from which this CG was created.",
"type": ['null', 'string'],
},
"share_types": {
"description": "The share types that shares in the CG are allowed to be a part of",
"type": "string"
},
},
"required": ["id", "name", "description", "created_at", "status", "project_id", "host"]
}
Request schemas
POST /consistencygroups
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Consistency Group (CG)",
"description": "A resource representing a group of shares that can be snapshotted in unison",
"type": "object",
"properties": {
"name": {
"description": "A non-unique name for a CG",
"type": "string",
'maxLength': 255,
},
"description": {
"description": "A short description of the CG",
"type": "string"
},
"source_cgsnapshot_id": {
"description": "The uuid of the cgsnapshot from which this CG was created. Cannot be supplied when 'share_types' is provided.",
"type": ['null', 'string'],
},
"share_types": {
"description": "The share types that shares in the CG are allowed to be a part of. Cannot be supplied when 'source_cgsnapshot_id' is provided.",
"type": "string"
},
},
"required": []
}
Response: detailed CG
PUT /consistencygroups
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Consistency Group (CG)",
"description": "A resource representing a group of shares that can be snapshotted in unison",
"type": "object",
"properties": {
"name": {
"description": "A non-unique name for a CG",
"type": "string",
'maxLength': 255,
},
"description": {
"description": "A short description of the CG",
"type": "string"
},
"required": []
}
Response: Detailed CG
GET /consistencygroups
Response: Simple CG
GET /consistencygroups/detail && GET /consistencygroups/<id>
Response: Detailed CG
