openstack/nova
Code Issues Proposed changes
e5884a8fd5
nova/api-ref/source/limits.inc

60 lines
1.5 KiB
PHP
Raw Normal View History

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. -*- rst -*-
=================
Limits (limits)
=================
api-ref: verfiy limits body This verify the limits.inc by only a small wording change part of bp:api-ref-in-rst Change-Id: I1f0ffbf913fc9db344d8cdf66bc3aa4339a2a75b
2016-05-02 01:54:38 +08:00
Shows rate and absolute limits for the project.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Show Rate And Absolute Limits
=============================
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: GET /limits
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
api-ref: verfiy limits body This verify the limits.inc by only a small wording change part of bp:api-ref-in-rst Change-Id: I1f0ffbf913fc9db344d8cdf66bc3aa4339a2a75b
2016-05-02 01:54:38 +08:00
Shows rate and absolute limits for the project.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Normal response codes: 200
Complet Method Verification of limits This complete the Method Verification of limits, as this is the only method supported. http://paste.openstack.org/show/495202/ has the method call and return sample value. also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: Ic1dca126d1acef3eaa8a56ef764f3ddefcb28ba4
2016-04-22 08:06:28 +08:00
Error response codes: unauthorized(401), forbidden(403)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
api-ref: Add missing parameters in limits.inc Add missing parameters in limits.inc. Fix inconsistency in the description ('instance' and 'server'). Change-Id: I9e361471024fd9618a7b6a7b49a1aeca810e6f05 Implements: blueprint api-ref-in-rst-pike Closes-Bug: #1654316
2017-06-20 12:30:39 +09:00
Request
-------
.. rest_parameters:: parameters.yaml
- reserved: reserved_query
- tenant_id: tenant_id_query
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Response
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
api-ref: limits.inc validate parameters Part of blueprint api-ref-in-rst Change-Id: I1b39ef719aa9dfcaec83b0d444baf41bb27ee813
2016-05-11 11:57:09 -07:00
.. rest_parameters:: parameters.yaml
- limits: limits
- absolute: limits_absolutes
[proxy-api] microversion 2.39 deprecates image-metadata proxy API Almost all proxy APIs were deprecated in microversion 2.36. But the sub-resource image-metadata of image was forgotten to deprecate. This patch deprecates the image-metdata API from 2.39. Implements blueprint deprecate-image-meta-proxy-api Closes-bug: #1614578 Change-Id: I5507337ab6fe4a377f66dec3fe275d75618cd7b4
2016-12-01 18:37:28 +03:00
- maxImageMeta: image_metadata_items
api-ref: limits.inc validate parameters Part of blueprint api-ref-in-rst Change-Id: I1b39ef719aa9dfcaec83b0d444baf41bb27ee813
2016-05-11 11:57:09 -07:00
- maxPersonality: injected_files
- maxPersonalitySize: injected_file_content_bytes
api-ref: Fix deprecated proxy API parameters All the network proxy APIs were deprecated in Newton. The related quotas have been filtered out in quotas APIs since I7311ad726f5ca50f5648a539b03c00e712235834. And they have also been filtered out in limits API since I00bad055847adbbe26fe2f9225a4adde18f546b8. But the API reference has not been updated yet. So fix it. Change-Id: Ie06585ab572cf6278a580bd3fdb1e86cbd0bcb7a Closes-Bug: #1654167
2017-01-05 15:45:23 +09:00
- maxSecurityGroupRules: security_group_rules_quota
- maxSecurityGroups: security_groups_quota
api-ref: limits.inc validate parameters Part of blueprint api-ref-in-rst Change-Id: I1b39ef719aa9dfcaec83b0d444baf41bb27ee813
2016-05-11 11:57:09 -07:00
- maxServerGroupMembers: server_group_members
- maxServerGroups: server_groups
- maxServerMeta: metadata_items
- maxTotalCores: cores
- maxTotalFloatingIps: floating_ips
- maxTotalInstances: instances
- maxTotalKeypairs: key_pairs
- maxTotalRAMSize: ram
api-ref: Add missing parameters in limits.inc Add missing parameters in limits.inc. Fix inconsistency in the description ('instance' and 'server'). Change-Id: I9e361471024fd9618a7b6a7b49a1aeca810e6f05 Implements: blueprint api-ref-in-rst-pike Closes-Bug: #1654316
2017-06-20 12:30:39 +09:00
- totalCoresUsed: total_cores_used
- totalFloatingIpsUsed: total_floatingips_used
- totalInstancesUsed: total_instances_used
- totalRAMUsed: total_ram_used
- totalSecurityGroupsUsed: total_security_groups_used
- totalServerGroupsUsed: total_server_groups_used
api-ref: limits.inc validate parameters Part of blueprint api-ref-in-rst Change-Id: I1b39ef719aa9dfcaec83b0d444baf41bb27ee813
2016-05-11 11:57:09 -07:00
- rate: limits_rates
Fix json response example heading in api ref Heading for json response example is wrong, it is json request instead of json response. Part of bp:api-ref-in-rst Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
2016-04-19 17:52:18 +09:00
**Example Show Rate And Absolute Limits: JSON response**
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Fix api ref for ips, limits, metdata and agent This patch fix API ref for correct sample files and status code for below APIs - ips - limits - server metadata - agents Part of bp:api-ref-in-rst Change-Id: I91b769eefde78381dc0feb6b5c8c6cf753203732
2016-04-19 19:32:48 +09:00
.. literalinclude:: ../../doc/api_samples/limits/limit-get-resp.json
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
:language: javascript
Copy Permalink