summaryrefslogtreecommitdiff
path: root/api-ref/source/images.inc
Commit message (Collapse)AuthorAgeFilesLines
* Keep pre-commit inline with hacking and fix whitespaceMonty Taylor2019-12-121-7/+7
| | | | | | | | | | | | | | | | | | The flake8 hook for pre-commit installs its own flake8 which is not what hacking is pinned to. This results in a bunch of errors. By doing a local hook we can cause these to be the same. There are flake8 exclusions in tox.ini that need to be used in pre-commit. Also we should exclude svg files from the whitespace modifications, because who cares. Once those are fixed, running pre-commit -a fixes some whitespace issues. While the normal use isn't to run -a - if someone does make a patch that touches any of these they'll get erroneous unrelated errors compared to their lower work - so fix all of the existing issues, which are mostly space-at-end-of-line issues it seems. Change-Id: I78e753492e99c03b30a0a691db3bd75ee3d289c9
* Update api-ref locationAndreas Jaeger2019-07-221-2/+2
| | | | | | | | | | | | | | | | The api documentation is now published on docs.openstack.org instead of developer.openstack.org. Update all links that are changed to the new location. Note that Neutron publishes to api-ref/network, not networking anymore. Note that redirects will be set up as well but let's point now to the new location. For details, see: http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html Change-Id: Id2cf3aa252df6db46575b5988e4937ecfc6792bb
* Fix api-ref: nova image-meta is deprecated from 2.39zhufl2018-03-261-1/+4
| | | | | | | | | | | | https://developer.openstack.org/api-ref/compute/#create-image-metadata says "These will fail with a 404 starting from microversion 2.36", but https://docs.openstack.org/nova/latest/reference/api-microversion-history.html#id35 says "2.39 Deprecates image-metadata proxy API", the system's actual behaviour is that image-metadata proxy API will fail with 404 starting from microversion 2.39, so this is to fix the api-ref. Change-Id: I159e5de59a228fde6c7a0647d3726ad3025b67ed
* Repair links in Nova documentationVu Cong Tuan2017-05-231-2/+2
| | | | | | | | | | | Some reference links are out of date. There's 404 error when trying to access them. For example: http://developer.openstack.org/api-ref/networking/ v2-ext/index.html#security-groups-security-groups Change-Id: Iead6a6f32cdb2c9067bb5425333ad043514edbce
* Clean up metadata param in docjichenjc2017-02-251-7/+7
| | | | | | | | | several params like metadata_xxx are used and actually they are same, so just clean up them and use metadata_object instead part of bp:api-ref-in-rst-pike Change-Id: I455c02b5dcd77df43fc8c0113269f71a5207d3d5
* Better wording for micorversion 2.36jichenjc2016-12-101-1/+1
| | | | | | | | | make it follow other descriptions, use start from to make it clear 2.36 is the first microversion deprecate those proxy Implements: blueprint api-ref-in-rst-ocata Change-Id: Iadf4bb6fa8e4a959a734f354206e2e1f4739e367
* api-ref: fix image GET response exampleMatt Riedemann2016-10-251-1/+1
| | | | | | | | This was using the images details GET response which is not the same as the specific image GET response format. Change-Id: I7db1cf374701b7321d2d55e1454ea5a612e6b421 Closes-Bug: #1636418
* Correct image.inc for headingghanshyam2016-09-141-1/+1
| | | | | | | | | This commit updates image.inc to remove create and update image from title Partially implements blueprint api-ref-in-rst Change-Id: Ib9aea5fd26585f6b81addfe4f0cdea00f2b2eaf5
* Mention proxy API deprecation microversion in api-refghanshyam2016-08-011-1/+1
| | | | | | | | | | | Proxy APIs are deprecated in microversion 2.36 which means all proxy APIs will return 404 after 2.35 version. It will be nice to mention that explicitly in api-ref too. Partially implements blueprint deprecate-api-proxies Change-Id: Iad210d215fb98bc247f049b23b97d8d7d4265c82
* api-ref: verify images.incghanshyam2016-06-241-13/+107
| | | | | | | | | This completes the verification of images.inc for all required area(parameter, example, body) Part of bp:api-ref-in-rst Change-Id: I47ed4d0b4446a0b45a1df312b84ec6bfdaa134b6
* Publish proxy APIs deprecation in api ref docghanshyam2016-06-141-3/+11
| | | | | | | | | | As first step to deprecate the proxy APIs, this commit publish the deprecation of proxy APIs in api ref doc. Partially implements blueprint deprecate-api-proxies Change-Id: Ie19ec5e27fef956061786646e8f9cc4e44d8ef0f
* remove /v2.1/{tenant_id} from all urlsSean Dague2016-06-031-33/+11
| | | | | | | | | | | | 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
* api-ref: image.inc - Update method validationSarafraj Singh2016-05-161-62/+55
| | | | | | | | | 1. Arranged all methods in canonical order 2. Validate all methods Part of bp:api-ref-in-rst Change-Id: If13ad63f0035e33cc1d9ea31315e64331deb5554
* add tags to files for the content verification phaseSean Dague2016-04-201-0/+4
| | | | | | | | | | This adds a set of tags in comments to the beginning of files so that we can process them according to the documentation here: https://wiki.openstack.org/wiki/NovaAPIRef Part of bp:api-ref-in-rst Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
* Merge "Final warnings removals for api-ref"Jenkins2016-04-201-1/+1
|\
| * Final warnings removals for api-refSean Dague2016-04-201-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This removes the final warnings from the api-ref code base, and flips the sphinx switch to enforce warnings as errors. It also adds code to the rest_parameters extension to make it more clear where a problem is when it comes to included parameters. This puts us in a place where we can start doing the file per file look at content. Part of bp:api-ref-in-rst Change-Id: Ic2c99d96d6addcafa00b9f16785c2fe59b1798d3
* | Merge "modify duplicate // to / in doc"Jenkins2016-04-201-10/+10
|\ \ | |/ |/|
| * modify duplicate // to / in docjichenjc2016-03-241-10/+10
| | | | | | | | | | | | Part of bp:api-ref-in-rst Change-Id: I1da87f0e8f0a6b45d60be58af2d13c8a236469d3
* | Fix remaining json reference warningsSean Dague2016-04-201-2/+1
|/ | | | | | | | | This fixes the last json reference warning which exist. It also trims out the baremetal API calls that we don't support any more (we only have the readonly proxy). That was erroneously added to the compute API docs in refactors of api-site last cycle. Change-Id: I08be639b610304049b0959902ed8876559111274
* Add remaining image API refghanshyam2016-04-191-5/+154
| | | | | | | | | | This commit adds remaining image and metadata API ref and also correct the existing one with status code and sample file name. Part of bp:api-ref-in-rst Change-Id: I9db88b0ad042501406d512e417440a1146027326
* Merge "Fix json response example heading in api ref"Jenkins2016-04-191-3/+3
|\
| * Fix json response example heading in api refghanshyam2016-04-191-3/+3
| | | | | | | | | | | | | | | | | | 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
* | Remove 40X and 50X from Normal response codesKen'ichi Ohmichi2016-04-181-5/+5
|/ | | | | | | | | HTTP 40X-50X are not normal response codes at all. This patch removes them from api-ref. Part of bp:api-ref-in-rst Change-Id: I32a29c9e2a3d69720e3a88e17ba36fe45fa902d9
* move sphinx h3 to '-' instead of '^'Sean Dague2016-04-151-10/+10
| | | | | | | | | | | | | | | 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
* Import RST files for documentationSean Dague2016-04-131-0/+154
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
View Lorry Controller Status