openstack/nova - nova - OpenDev: Free Software Needs Free Tools

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 -*-

Deprecate os-hosts API This patch deprecates os-hosts APIs including: GET /os-hosts - list hosts GET /os-hosts/{host_name} - show host details PUT /os-hosts/{host_name} - update host status GET /os-hosts/{host_name}/reboot - reboot host GET /os-hosts/{host_name}/shutdown - shutdown host GET /os-hosts/{host_name}/startup - start host Much of the ``os-hosts`` API is duplicated with the ``os-services`` and ``os-hypervisors`` APIs. It's not a good idea to make nova have the compute related API, so this patch deprecated them. Implements blueprint deprecate-os-hosts Co-Authored-By: Matt Riedemann <mriedem.os@gmail.com> Change-Id: Ieb85653b85a1eff38a9fb0c9ff05e4cd39150ecc

2017年03月27日 17:49:11 +08:00

.. _os-services:

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

================================

Compute services (os-services)

================================

api-ref: fix description in os-services The services data model and API is not per-tenant, it's per-region, so this change updates the docs to reflect that. Change-Id: I45bc0bd5afcd05626f61be84c012e00f723f80eb

2017年03月16日 18:00:13 -04:00

Lists all running Compute services in a region, enables or disables

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

scheduling for a Compute service, logs disabled Compute service

information, and deletes a Compute service.

For an overview of Compute services, see `OpenStack

api-ref: Nova Update Compute services Link update the os-service Link. Change-Id: I4485156a0e19a400f1f7218345759bc92bb0e08e

2017年04月12日 14:57:11 +08:00

Compute <https://docs.openstack.org/ocata/install-guide-obs/common/get-started-compute.html>`__.

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

List Compute Services

=====================

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 /os-services

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

Complet Method Verification of os-services This complete the Method Verification of os-services, http://paste.openstack.org/show/495349/ 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: Ie4662e033b3b2235e62fd95ea50291ae91362d21

2016年04月22日 17:13:10 +08:00

Lists all running Compute services.

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

Provides details why any services were disabled.

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 os-services This complete the Method Verification of os-services, http://paste.openstack.org/show/495349/ 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: Ie4662e033b3b2235e62fd95ea50291ae91362d21

2016年04月22日 17:13:10 +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

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

.. rest_parameters:: parameters.yaml

- services: services

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

- id: service_id_body

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

- binary: binary

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

- disabled_reason: disabled_reason_body

- host: host_name_body

Final warnings removals for api-ref 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

2016年04月20日 11:20:05 -04:00

- state: service_state

api-ref: finish validation for os-server-external-events.inc This completes the validation for the admin event interface, including detailing the codes we currently return in the parameter list. Because os-service was incorrectly using the 'status' key, when I renamed status => event_status I needed to also create a service_status to make things compile. It's accurate enough to move forward. Because this is really a Neutron only API, this is moved towards the bottom of the API list, to make it clear this isn't really designed to be used by end user apps. Part of bp:api-ref-in-rst Change-Id: I3ed46eec1c33a63b7a89d6d6b5eeda574effdc56

2016年05月11日 14:47:13 -04:00

- status: service_status

Final warnings removals for api-ref 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

2016年04月20日 11:20:05 -04:00

- updated_at: updated

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

- forced_down: forced_down

Final warnings removals for api-ref 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

2016年04月20日 11:20:05 -04:00

- zone: OS-EXT-AZ:availability_zone

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

**Example List Compute Services**

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

.. literalinclude:: ../../doc/api_samples/os-services/v2.11/services-list-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

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

Disable Scheduling For A Compute Service

========================================

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

.. rest_method:: PUT /os-services/disable

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

Disables scheduling for a Compute service with optional logging.

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

Specify the service by its host name and binary name.

Normal response codes: 200

Complet Method Verification of os-services This complete the Method Verification of os-services, http://paste.openstack.org/show/495349/ 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: Ie4662e033b3b2235e62fd95ea50291ae91362d21

2016年04月22日 17:13:10 +08:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)

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

Request

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

.. rest_parameters:: parameters.yaml

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

- host: host_name_body

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

- binary: binary

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

**Example Disable Scheduling For A Compute Service**

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

.. literalinclude:: ../../doc/api_samples/os-services/service-disable-put-req.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

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

.. rest_parameters:: parameters.yaml

- service: service

- binary: binary

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

- host: host_name_body

api-ref: finish validation for os-server-external-events.inc This completes the validation for the admin event interface, including detailing the codes we currently return in the parameter list. Because os-service was incorrectly using the 'status' key, when I renamed status => event_status I needed to also create a service_status to make things compile. It's accurate enough to move forward. Because this is really a Neutron only API, this is moved towards the bottom of the API list, to make it clear this isn't really designed to be used by end user apps. Part of bp:api-ref-in-rst Change-Id: I3ed46eec1c33a63b7a89d6d6b5eeda574effdc56

2016年05月11日 14:47:13 -04:00

- status: service_status

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

**Example Disable Scheduling For A Compute Service**

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

.. literalinclude:: ../../doc/api_samples/os-services/service-disable-put-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

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

Log Disabled Compute Service Information

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

.. rest_method:: PUT /os-services/disable-log-reason

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

Logs information to the Compute service table about why a Compute service was disabled.

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

Specify the service by its host name and binary name.

Normal response codes: 200

Complet Method Verification of os-services This complete the Method Verification of os-services, http://paste.openstack.org/show/495349/ 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: Ie4662e033b3b2235e62fd95ea50291ae91362d21

2016年04月22日 17:13:10 +08:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)

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

Request

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

.. rest_parameters:: parameters.yaml

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

- host: host_name_body

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

- binary: binary

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

- disabled_reason: disabled_reason_body

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

**Example Log Disabled Compute Service Information**

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

.. literalinclude:: ../../doc/api_samples/os-services/service-disable-log-put-req.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

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

.. rest_parameters:: parameters.yaml

- service: service

- binary: binary

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

- disabled_reason: disabled_reason_body

- host: host_name_body

api-ref: finish validation for os-server-external-events.inc This completes the validation for the admin event interface, including detailing the codes we currently return in the parameter list. Because os-service was incorrectly using the 'status' key, when I renamed status => event_status I needed to also create a service_status to make things compile. It's accurate enough to move forward. Because this is really a Neutron only API, this is moved towards the bottom of the API list, to make it clear this isn't really designed to be used by end user apps. Part of bp:api-ref-in-rst Change-Id: I3ed46eec1c33a63b7a89d6d6b5eeda574effdc56

2016年05月11日 14:47:13 -04:00

- status: service_status

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

**Example Log Disabled Compute Service Information**

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

.. literalinclude:: ../../doc/api_samples/os-services/service-disable-log-put-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

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

Enable Scheduling For A Compute Service

=======================================

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

.. rest_method:: PUT /os-services/enable

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

Enables scheduling for a Compute service.

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

Specify the service by its host name and binary name.

Normal response codes: 200

Complet Method Verification of os-services This complete the Method Verification of os-services, http://paste.openstack.org/show/495349/ 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: Ie4662e033b3b2235e62fd95ea50291ae91362d21

2016年04月22日 17:13:10 +08:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)

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

Request

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

.. rest_parameters:: parameters.yaml

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

- host: host_name_body

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

- binary: binary

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

**Example Enable Scheduling For A Compute Service**

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

.. literalinclude:: ../../doc/api_samples/os-services/service-enable-put-req.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

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

.. rest_parameters:: parameters.yaml

- service: service

- binary: binary

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

- host: host_name_body

api-ref: finish validation for os-server-external-events.inc This completes the validation for the admin event interface, including detailing the codes we currently return in the parameter list. Because os-service was incorrectly using the 'status' key, when I renamed status => event_status I needed to also create a service_status to make things compile. It's accurate enough to move forward. Because this is really a Neutron only API, this is moved towards the bottom of the API list, to make it clear this isn't really designed to be used by end user apps. Part of bp:api-ref-in-rst Change-Id: I3ed46eec1c33a63b7a89d6d6b5eeda574effdc56

2016年05月11日 14:47:13 -04:00

- status: service_status

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

**Example Enable Scheduling For A Compute Service**

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, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

.. literalinclude:: ../../doc/api_samples/os-services/service-enable-put-resp.json

:language: javascript

Update Forced Down

==================

.. rest_method:: PUT /os-services/force-down

Set or unset ``forced_down`` flag for the service.

Action ``force-down`` available as of microversion 2.11.

Specify the service by its host name and binary name.

Normal response codes: 200

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)

Request

-------

.. rest_parameters:: parameters.yaml

- host: host_name_body

- binary: binary

- forced_down: forced_down

**Example Update Forced Down**

.. literalinclude:: ../../doc/api_samples/os-services/v2.11/service-force-down-put-req.json

:language: javascript

Response

--------

.. rest_parameters:: parameters.yaml

- service: service

- binary: binary

- forced_down: forced_down

- host: host_name_body

|

**Example Update Forced Down**

.. literalinclude:: ../../doc/api_samples/os-services/v2.11/service-force-down-put-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

Delete Compute Service

======================

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:: DELETE /os-services/{service_id}

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: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

2016年10月10日 14:50:17 -04:00

Deletes a Compute service. If it's a nova-compute service, then the

corresponding host will be removed from all the host aggregates as well.

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 os-service related reference missing "Delete a service " API returns 204 as success, 404 is error Also some reference to doc it not correct Part of bp:api-ref-in-rst Change-Id: Ibf57167ae70acdaa2ad6f0abc3a975c91e797b87

2016年03月23日 09:21:21 +08:00

Normal response codes: 204

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

Complet Method Verification of os-services This complete the Method Verification of os-services, http://paste.openstack.org/show/495349/ 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: Ie4662e033b3b2235e62fd95ea50291ae91362d21

2016年04月22日 17:13:10 +08:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)

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

Request

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

.. rest_parameters:: parameters.yaml

Final warnings removals for api-ref 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

2016年04月20日 11:20:05 -04:00

- service_id: service_id_path

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

--------

api-ref, os-services.inc Verified parameters, examples, body text. Included v2.11 sample files for GET and PUT os-services. Part of: bp/api-ref-in-rst Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

2016年05月25日 12:35:09 -04:00

API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

2016年10月10日 14:50:17 -04:00

If successful, this method does not return content in the response body.

openstack/nova - nova - OpenDev: Free Software Needs Free Tools

244 lines 5.5 KiB PHP Raw Normal View History Unescape Escape

244 lines

5.5 KiB

PHP

Raw Normal View History