diff --git a/api-ref/source/dns-api-v2-limits.inc b/api-ref/source/dns-api-v2-limits.inc new file mode 100644 index 000000000..106fb3666 --- /dev/null +++ b/api-ref/source/dns-api-v2-limits.inc @@ -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 + + diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 0ab6cb058..fb1c01816 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -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 diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index a6971747a..6622023d4 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -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 + ############################# # Variables # ############################# diff --git a/api-ref/source/samples/limits/get-limits-response.json b/api-ref/source/samples/limits/get-limits-response.json new file mode 100644 index 000000000..fbe94e6ee --- /dev/null +++ b/api-ref/source/samples/limits/get-limits-response.json @@ -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 +}