Revision as of 15:23, 29 July 2015

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"]
}

Simple CG Snapshot

{
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Consistency Group Snapshot",
   "description": "A resource representing a snapshot of a group of shares",
   "type": "object",
   "properties": {
       "id": {
           "description": "The unique identifier for a product",
           "type": "integer"
       },
       "name": {
           "description": "A non-unique name for a CGsnapshot",
           "type": "string"
       },
   },
   "required": ["id", "name"]
}

Detailed CG Snapshot

{
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Consistency Group Snapshot",
   "description": "A resource representing a snapshot of a group of shares",
   "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 snapshot",
           "type": "string",
           'maxLength': 255,
       },
       "description": {
           "description": "A short description of the CG snapshot",
           "type": "string"
       },
       "created_at": {
           "description": "The time at which the CG snapshot was created",
           "type": "string"
       },
       "status": {
           "description": "Status of the CG snapshot",
           "type": "string",
           "enum": ["ACTIVE", "ERROR"]
       },
       "project_id": {
           "description": "The owner of the CG snapshot",
           "type": "string"
       },
       "consistency_group_id": {
           "description": "The uuid of the consistency group from which this CG snapshot was created.",
           "type": ['null', 'string'],
       },
       "share_types": {
           "description": "The share types that will be inherited if a CG is created from this snapshot",
           "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

GET /consistencygroups

Response: Simple CG

GET /consistencygroups/detail

Response: Detailed CG

GET /consistencygroups/<id>

Response: Detailed CG

PUT /consistencygroups/<id>

{
   "$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

POST /cgsnapshots

{
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Consistency Group Snapshots",
   "description": "TODO",
   "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"
       },
       "consistency_group_id": {
           "description": "The uuid of the CG from which to create this CG snapshot.",
           "type": 'string',
       },
   },
   "required": []
}

Response: detailed CG

PUT /cgsnapshots/<id>

{
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Consistency Group Snapshots",
   "description": "TODO",
   "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