Add Limits to API-Ref Docs
Change-Id: Id327bfbf93e78064806a8efff8c1e20aac8cc2ba
This commit is contained in:
parent
c41555d8ee
commit
21569891c7
53
api-ref/source/dns-api-v2-limits.inc
Normal file
53
api-ref/source/dns-api-v2-limits.inc
Normal file
@ -0,0 +1,53 @@
|
||||
======
|
||||
Limits
|
||||
======
|
||||
|
||||
Show the limits for the current project
|
||||
|
||||
|
||||
Get Project Limits
|
||||
==================
|
||||
|
||||
.. rest_method:: GET /v2/limits
|
||||
|
||||
Create a zone
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:405,404,403,401,400,503,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- x-auth-token: x-auth-token
|
||||
- x-auth-all-projects: x-auth-all-projects
|
||||
- x-auth-sudo-project-id: x-auth-sudo-project-id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- x-openstack-request-id: x-openstack-request-id
|
||||
- max_page_limit: max_page_limit
|
||||
- max_recordset_name_length: max_recordset_name_length
|
||||
- max_recordset_records: max_recordset_records
|
||||
- max_zone_name_length: max_zone_name_length
|
||||
- max_zone_records: max_zone_records
|
||||
- max_zone_recordsets: max_zone_recordsets
|
||||
- max_zones: max_zones
|
||||
- min_ttl: min_ttl
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/limits/get-limits-response.json
|
||||
:language: javascript
|
||||
|
||||
|
@ -13,3 +13,4 @@
|
||||
.. include:: dns-api-v2-zone-ownership-transfer-request.inc
|
||||
.. include:: dns-api-v2-zone-ownership-transfer-accept.inc
|
||||
.. include:: dns-api-v2-recordset.inc
|
||||
.. include:: dns-api-v2-limits.inc
|
||||
|
@ -738,6 +738,80 @@ zone_transfer_request_zone_name:
|
||||
required: true
|
||||
type: string
|
||||
|
||||
|
||||
#############################
|
||||
# Limits Variables #
|
||||
#############################
|
||||
|
||||
|
||||
# Header Variables
|
||||
###################
|
||||
|
||||
# Path Variables
|
||||
#################
|
||||
|
||||
# Query Variables
|
||||
##################
|
||||
|
||||
# Body Variables
|
||||
#################
|
||||
|
||||
max_page_limit:
|
||||
description: |
|
||||
The max amount of items allowed per page
|
||||
in: body
|
||||
required: true
|
||||
type: integer
|
||||
|
||||
max_recordset_name_length:
|
||||
description: |
|
||||
The max length of a recordset name
|
||||
in: body
|
||||
required: true
|
||||
type: integer
|
||||
|
||||
max_recordset_records:
|
||||
description: |
|
||||
The max amount of records contained in a recordset
|
||||
in: body
|
||||
required: true
|
||||
type: integer
|
||||
|
||||
max_zone_name_length:
|
||||
description: |
|
||||
The max length of a zone name
|
||||
in: body
|
||||
required: true
|
||||
type: integer
|
||||
|
||||
max_zone_records:
|
||||
description: |
|
||||
The max amount of records in a zone
|
||||
in: body
|
||||
required: true
|
||||
type: integer
|
||||
|
||||
max_zone_recordsets:
|
||||
description: |
|
||||
The max amount of recordsets per zone
|
||||
in: body
|
||||
required: true
|
||||
type: integer
|
||||
|
||||
max_zones:
|
||||
description: |
|
||||
The max amount of zones for this project
|
||||
in: body
|
||||
required: true
|
||||
type: integer
|
||||
|
||||
min_ttl:
|
||||
description: |
|
||||
The lowest ttl allowed on this system
|
||||
in: body
|
||||
required: true
|
||||
type: integer
|
||||
|
||||
#############################
|
||||
# <ITEM> Variables #
|
||||
#############################
|
||||
|
10
api-ref/source/samples/limits/get-limits-response.json
Normal file
10
api-ref/source/samples/limits/get-limits-response.json
Normal file
@ -0,0 +1,10 @@
|
||||
{
|
||||
"max_page_limit": 1000,
|
||||
"max_recordset_name_length": 255,
|
||||
"max_recordset_records": 20,
|
||||
"max_zone_name_length": 255,
|
||||
"max_zone_records": 500,
|
||||
"max_zone_recordsets": 500,
|
||||
"max_zones": 10,
|
||||
"min_ttl": null
|
||||
}
|
Loading…
Reference in New Issue
Block a user