"Fossies" - the Fresh Open Source Software Archive

Member "senlin-8.0.0/api-ref/source/policy_types.inc" (16 Oct 2019, 2211 Bytes) of package /linux/misc/openstack/senlin-8.0.0.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) fasm source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. For more information about "policy_types.inc" see the Fossies "Dox" file reference documentation.

    1 ===========================
    2 Policy Types (policy-types)
    3 ===========================
    4 
    5 Lists all policy types and shows details for a policy type.
    6 
    7 List policy types
    8 =================
    9 
   10 .. rest_method::  GET /v1/policy-types
   11 
   12 Lists all supported policy types.
   13 
   14 Response Codes
   15 --------------
   16 
   17 .. rest_status_code:: success status.yaml
   18 
   19    - 200
   20 
   21 .. rest_status_code:: error status.yaml
   22 
   23    - 401
   24    - 403
   25    - 503
   26 
   27 Request Parameters
   28 ------------------
   29 
   30 .. rest_parameters:: parameters.yaml
   31 
   32   - OpenStack-API-Version: microversion
   33 
   34 Response Parameters
   35 -------------------
   36 
   37 .. rest_parameters:: parameters.yaml
   38 
   39   - X-OpenStack-Request-Id: request_id
   40   - policy_types: policy_types
   41 
   42 Response Example
   43 ----------------
   44 
   45 For API microversion lower than 1.5, the response only contains the name for
   46 each policy type:
   47 
   48 .. literalinclude:: samples/policy-types-list-response.json
   49    :language: javascript
   50 
   51 Since API microversion 1.5, the response contains the support status of each
   52 policy type and the version is provided using a separate key:
   53 
   54 .. literalinclude:: samples/policy-types-list-response-v1.5.json
   55    :language: javascript
   56 
   57 
   58 Show policy type details
   59 ========================
   60 
   61 .. rest_method::  GET /v1/policy-types/{policy_type}
   62 
   63 Shows details for a policy type.
   64 
   65 Response Codes
   66 --------------
   67 
   68 .. rest_status_code:: success status.yaml
   69 
   70    - 200
   71 
   72 .. rest_status_code:: error status.yaml
   73 
   74    - 401
   75    - 403
   76    - 404
   77    - 503
   78 
   79 Request Parameters
   80 ------------------
   81 
   82 .. rest_parameters:: parameters.yaml
   83 
   84   - OpenStack-API-Version: microversion
   85   - policy_type: policy_type_url
   86 
   87 Response Parameters
   88 -------------------
   89 
   90 .. rest_parameters:: parameters.yaml
   91 
   92   - X-OpenStack-Request-Id: request_id
   93   - policy_type: policy_type
   94   - name: policy_type_name
   95   - schema: policy_type_schema
   96 
   97 Response Example
   98 ----------------
   99 
  100 For API microversion lower than 1.5, the response only contains the name and
  101 schema of the specified policy type:
  102 
  103 .. literalinclude:: samples/policy-type-show-response.json
  104    :language: javascript
  105 
  106 Since API microversion 1.5, the response contains the support status of the
  107 specified policy type:
  108 
  109 .. literalinclude:: samples/policy-type-show-response-v1.5.json
  110    :language: javascript
  111