openinfra/refstack
Code Issues Proposed changes

Move implemented specs from the approved directory to the implemented directory.

Browse Source 
Update the specs to match implementation details.

Change-Id: Iac1cfec9174350d081ff221f82cf314e4a5ca4d7
This commit is contained in:
Catherine Diep 2016-06-15 12:58:06 -07:00
parent 3c82bc3443
commit ae1acf2b33
7 changed files with 71 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
specs/mitaka/approved/product-registration-api.rst → specs/mitaka/implemented/product-registration-api.rst
View File

@ -104,28 +104,31 @@ The following REST APIs will be added to RefStack.
"description" : "My description",
"product_id" : "7e0072fb-a3e9-4901-82cd-9a3a911507d8",
"product_type" : 1,
"public" : 1,
"public" : true,
"type" : 0,
"can_manage" : false,
"organization_id" : "69346866-307f-4052-ba31-ff6270635e19"
},
{
"id" : "78346866-307f-4052-ba31-ff6270635e19",
"name" : "Product EFG",
"description" : "My description"
"description" : "My description",
"product_id" : "8c9u72fb-a3e9-4901-82cd-9a3a911507d8",
"product_type" : 0,
"public" : 1,
"public" : true,
"type" : 1,
"can_manage" : false,
"organization_id" : "87346866-307f-4052-ba31-ff6270635e19"
},
{
"id" : "12346866-307f-4052-ba31-ff6270635e19",
"name" : "Product HIJ",
"description" : "My description"
"description" : "My description",
"product_id" : "987672fb-a3e9-4901-82cd-9a3a911507d8",
"product_type" : 2,
"public" : 1,
"public" : true,
"type" : 0,
"can_manage" : false,
"organization_id" : "77346866-307f-4052-ba31-ff6270635e19"
},
......
@ -172,11 +175,12 @@ The following REST APIs will be added to RefStack.
{
"id" : "12346866-307f-4052-ba31-ff6270635e19",
"name" : "Product HIG",
"description" : "My description"
"description" : "My description",
"product_id" : "987672fb-a3e9-4901-82cd-9a3a911507d8",
"product_type" : 2,
"public" : 1,
"public" : true,
"type" : 0,
"can_manage" : false,
"organization_id" : "77346866-307f-4052-ba31-ff6270635e19"
}
}
@ -191,12 +195,13 @@ The following REST APIs will be added to RefStack.
"description" : "My description"
"product_id" : "987672fb-a3e9-4901-82cd-9a3a911507d8",
"product_type" : 2,
"public" : 1,
"public" : true,
"properties" : "some text"
"created_at": "2016-02-01 08:42:25",
"created_by_user": "john@abc.com",
"updated_at": "2016-02-02 08:42:25",
"type" : 0,
"can_manage" : true,
"organization_id" : "77346866-307f-4052-ba31-ff6270635e19"
}
}
@ -233,9 +238,9 @@ The following REST APIs will be added to RefStack.
.. parsed-literal::
{
"name" : "ABC",
"description" : "My description"
"description" : "My description",
"product_type" : 2,
"organization_id" : "95346866-307f-4052-ba31-ff6270635e14"
"organization_id" : "95346866-307f-4052-ba31-ff6270635e14",
"required": ["name", "product_type"]
}
@ -282,10 +287,10 @@ The following REST APIs will be added to RefStack.
{
{
"name" : "Product EFG",
"description" : "My description"
"description" : "My description",
"product_id" : "987672fb-a3e9-4901-82cd-9a3a911507d8",
"public" : 1,
"properties" : "some text"
"public" : true,
"properties" : "some text",
"required": []
}
}
@ -300,9 +305,14 @@ The following REST APIs will be added to RefStack.
"description" : "My description",
"product_id" : "987672fb-a3e9-4901-82cd-9a3a911507d8",
"product_type" : 2,
"public" : 1,
"properties" : "some text"
"type" : 1,
"public" : true,
"properties" : "some text",
"created_at": "2016-02-01 08:42:25",
"created_by_user": "john@abc.com",
"updated_at": "2016-02-02 08:42:25",
"type" : 0,
"can_manage" : true,
"organization_id" : "77346866-307f-4052-ba31-ff6270635e19"
}
}

0
specs/mitaka/approved/use-url-as-cpid.rst → specs/mitaka/implemented/use-url-as-cpid.rst
View File

0
specs/mitaka/approved/user-group.rst → specs/mitaka/implemented/user-group.rst
View File

0
specs/mitaka/approved/vendor-registration-data-model.rst → specs/mitaka/implemented/vendor-registration-data-model.rst
View File

0
specs/mitaka/approved/vendor-user-management-api.rst → specs/mitaka/implemented/vendor-user-management-api.rst
View File

0
specs/mitaka/approved/defcore-guideline-api.rst → specs/newton/implemented/defcore-guideline-api.rst
View File

45
specs/mitaka/approved/vendor-registration-api.rst → specs/newton/implemented/vendor-registration-api.rst
View File

@ -328,6 +328,51 @@ The following REST APIs will be added to RefStack.
* JSON schema definition for the response data: N/A
**Cancel submitted register request**
* Description:
This API will be used by the vendor admins to cancel previously submitted register
requests.
* Method type: POST
* URI: v1/vendors/{vendor_id}/action
* Normal Response Codes:
* OK (202)
* Error Response Codes:
* Bad Request (400)
* Unauthorized (401)
* Not found (404)
* Request parameters:
+---------------+-------+--------------+-----------------------------------+
| Parameter | Style | Type | Description |
+===============+=======+==============+===================================+
| vendor_id | URI | csapi:UUID | Vendor ID for update. |
+---------------+-------+--------------+-----------------------------------+
| cancel | plain | xsd:string | Action to request canceling a |
| | | | previously submitted register |
| | | | request. |
| | | | Vendor "type" will change from |
| | | | "pending" to "private". |
+---------------+-------+--------------+-----------------------------------+
* JSON schema definition for the body data:
.. parsed-literal::
{
"cancel" : null
}
* JSON schema definition for the response data: N/A
**Approve to become an official vendor**
* Description: