api-ref doc for profile validation

This adds api-ref documentation for the profile_validate api.

Change-Id: I078803d1624503e55d2f1339b3bdbc2b6fe302fb
This commit is contained in:
tengqm 2016-08-27 03:20:14 -04:00
parent 0f0d60f868
commit e28cc030cd
1 changed files with 49 additions and 0 deletions

View File

@ -286,3 +286,52 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- X-OpenStack-Request-Id: request_id
Validate profile
================
.. rest_method:: POST /v1/profiles/validate
Validates a profile.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 503
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- OpenStack-API-Version: microversion
- profile: profile
- spec: profile_spec
Response Parameters
-------------------
The response contains properties as if the profile is created.
.. rest_parameters:: parameters.yaml
- X-OpenStack-Request-Id: request_id
- created_at: created_at
- domain: domain
- id: profile_id
- metadata: metadata
- name: name
- project: project
- spec: profile_spec
- type: profile_type_name
- updated_at: updated_at
- user: user