diff --git a/doc/admin-guide/source/identity-security-compliance.rst b/doc/admin-guide/source/identity-security-compliance.rst index d03c05380a..be3e8436f6 100644 --- a/doc/admin-guide/source/identity-security-compliance.rst +++ b/doc/admin-guide/source/identity-security-compliance.rst @@ -162,6 +162,6 @@ old password. .. _Security Hardening PCI-DSS: http://specs.openstack.org/openstack/keystone-specs/specs/keystone/newton/pci-dss.html -.. _v2.0: http://developer.openstack.org/api-ref/identity/v2-admin/index.html?expanded=update-user-admin-endpoint-detail#update-user-admin-endpoint +.. _v2.0: https://developer.openstack.org/api-ref/identity/v2-admin/index.html?expanded=update-user-admin-endpoint-detail#update-user-admin-endpoint -.. _v3: http://developer.openstack.org/api-ref/identity/v3/index.html#update-user +.. _v3: https://developer.openstack.org/api-ref/identity/v3/index.html#update-user diff --git a/doc/admin-guide/source/networking-auth.rst b/doc/admin-guide/source/networking-auth.rst index 3b0176a75d..63011c4a4c 100644 --- a/doc/admin-guide/source/networking-auth.rst +++ b/doc/admin-guide/source/networking-auth.rst @@ -11,7 +11,7 @@ to the Networking service must provide an authentication token in authenticating with the Identity service endpoint. For more information about authentication with the Identity service, see `OpenStack Identity service API v2.0 -Reference `__. +Reference `__. When the Identity service is enabled, it is not mandatory to specify the project ID for resources in create requests because the project ID is derived from the authentication token. diff --git a/doc/admin-guide/source/networking-introduction.rst b/doc/admin-guide/source/networking-introduction.rst index 9e0580418a..540c1f30ac 100644 --- a/doc/admin-guide/source/networking-introduction.rst +++ b/doc/admin-guide/source/networking-introduction.rst @@ -12,7 +12,7 @@ firewalls, and IPsec VPN. For a detailed description of the Networking API abstractions and their attributes, see the `OpenStack Networking API v2.0 -Reference `__. +Reference `__. .. note:: diff --git a/doc/admin-guide/source/shared-file-systems-services-manage.rst b/doc/admin-guide/source/shared-file-systems-services-manage.rst index 6f9bf20b9a..351082bc0a 100644 --- a/doc/admin-guide/source/shared-file-systems-services-manage.rst +++ b/doc/admin-guide/source/shared-file-systems-services-manage.rst @@ -6,7 +6,7 @@ Manage shares services The Shared File Systems service provides API that allows to manage running share services (`Share services API -`_). +`_). Using the :command:`manila service-list` command, it is possible to get a list of all kinds of running services. To select only share services, you can pick items that have field ``binary`` equal to ``manila-share``. Also, you can diff --git a/doc/admin-guide/source/telemetry-data-retrieval.rst b/doc/admin-guide/source/telemetry-data-retrieval.rst index 956acfd9db..75b6bb668c 100644 --- a/doc/admin-guide/source/telemetry-data-retrieval.rst +++ b/doc/admin-guide/source/telemetry-data-retrieval.rst @@ -28,7 +28,7 @@ retrieve data, as described in :ref:`telemetry-users-roles-projects`. Further information about the available API endpoints can be found in the `Telemetry API Reference -`__. +`__. Query ----- diff --git a/doc/arch-design-draft/source/design-control-plane.rst b/doc/arch-design-draft/source/design-control-plane.rst index ec96190f45..8b76298b51 100644 --- a/doc/arch-design-draft/source/design-control-plane.rst +++ b/doc/arch-design-draft/source/design-control-plane.rst @@ -250,7 +250,7 @@ Application Programming Interface (API) All public access, whether direct, through a command-line client, or through the web-based dashboard, uses the API service. Find the API reference at `Development resources for OpenStack clouds -`_. +`_. You must choose whether you want to support the Amazon EC2 compatibility APIs, or just the OpenStack APIs. One issue you might encounter when @@ -276,7 +276,7 @@ Extensions ~~~~~~~~~~ The `API -Specifications `_ define +Specifications `_ define the core actions, capabilities, and mediatypes of the OpenStack API. A client can always depend on the availability of this core API, and implementers are always required to support it in its entirety. diff --git a/doc/common/app-support.rst b/doc/common/app-support.rst index 4329cfbe84..e75850a58a 100644 --- a/doc/common/app-support.rst +++ b/doc/common/app-support.rst @@ -77,7 +77,7 @@ command-line clients: The following documentation provides reference and guidance information for the OpenStack APIs: -* `API Guide `__ +* `API Guide `__ The following guide provides how to contribute to OpenStack documentation: diff --git a/doc/common/get-started-logical-architecture.rst b/doc/common/get-started-logical-architecture.rst index 5a51ceb20d..181d131b74 100644 --- a/doc/common/get-started-logical-architecture.rst +++ b/doc/common/get-started-logical-architecture.rst @@ -27,7 +27,7 @@ Users can access OpenStack via the web-based user interface implemented by :doc:`Dashboard `, via `command-line clients `__ and by issuing API requests through tools like browser plug-ins or :command:`curl`. -For applications, `several SDKs `__ +For applications, `several SDKs `__ are available. Ultimately, all these access methods issue REST API calls to the various OpenStack services. diff --git a/doc/contributor-guide/source/api-guides.rst b/doc/contributor-guide/source/api-guides.rst index 2dfdc17ce9..b9c19d5255 100644 --- a/doc/contributor-guide/source/api-guides.rst +++ b/doc/contributor-guide/source/api-guides.rst @@ -148,9 +148,9 @@ documentation, patch the ``reference/projects.yaml`` file in the -.. _`developer.openstack.org`: http://developer.openstack.org +.. _`developer.openstack.org`: https://developer.openstack.org .. _`wadl2rst`: http://github.com/annegentle/wadl2rst -.. _`Compute API Guide`: http://developer.openstack.org/api-guide/compute +.. _`Compute API Guide`: https://developer.openstack.org/api-guide/compute .. _`example patch`: https://review.openstack.org/#/c/233446/ .. _`API documentation guidelines`: http://specs.openstack.org/openstack/api-wg/guidelines/api-docs.html .. _`nova example`: https://github.com/openstack/nova/blob/master/api-ref/source/conf.py diff --git a/doc/contributor-guide/source/blueprints-and-specs.rst b/doc/contributor-guide/source/blueprints-and-specs.rst index 2172f3976f..6fcaed50b5 100644 --- a/doc/contributor-guide/source/blueprints-and-specs.rst +++ b/doc/contributor-guide/source/blueprints-and-specs.rst @@ -190,7 +190,7 @@ Guides for end users Shows OpenStack end users how to create and manage resources in an OpenStack cloud with the OpenStack dashboard and OpenStack client commands. * `OpenStack API Guide - `_: + `_: A brief overview of how to send REST API requests to endpoints for OpenStack services. * `OpenStack Command-Line Interface Reference @@ -210,7 +210,7 @@ Guides for end users * - OpenStack API Guide - http://git.openstack.org/cgit/openstack/api-site/tree/api-quick-start - - http://developer.openstack.org/api-guide/quick-start/ + - https://developer.openstack.org/api-guide/quick-start/ * - OpenStack Command-Line Interface Reference - http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/cli-reference @@ -219,7 +219,7 @@ Guides for end users API documentation ----------------- -* `Complete API Reference `_: +* `Complete API Reference `_: Complete reference listing of OpenStack REST APIs with example requests and responses. * `API specifications `_: diff --git a/doc/networking-guide/source/config-lbaas.rst b/doc/networking-guide/source/config-lbaas.rst index 659f06a674..0b38daa355 100644 --- a/doc/networking-guide/source/config-lbaas.rst +++ b/doc/networking-guide/source/config-lbaas.rst @@ -67,7 +67,7 @@ Health monitor LBaaS v2 has multiple implementations via different service plug-ins. The two most common implementations use either an agent or the Octavia services. Both -implementations use the `LBaaS v2 API `_. +implementations use the `LBaaS v2 API `_. Configurations ~~~~~~~~~~~~~~ diff --git a/doc/networking-guide/source/config-routed-networks.rst b/doc/networking-guide/source/config-routed-networks.rst index 128692957f..9c483949f9 100644 --- a/doc/networking-guide/source/config-routed-networks.rst +++ b/doc/networking-guide/source/config-routed-networks.rst @@ -84,7 +84,7 @@ provider networks. We recommend using the following procedure: * Segmentation ID For example, ``provider1``, ``VLAN``, and ``2016``. See the - `API reference `__ + `API reference `__ for more information. Within a network, use a unique physical network name for each segment which diff --git a/doc/ops-guide/source/arch-cloud-controller.rst b/doc/ops-guide/source/arch-cloud-controller.rst index 3e3603aaee..f8a1173416 100644 --- a/doc/ops-guide/source/arch-cloud-controller.rst +++ b/doc/ops-guide/source/arch-cloud-controller.rst @@ -247,7 +247,7 @@ Application Programming Interface (API) All public access, whether direct, through a command-line client, or through the web-based dashboard, uses the API service. Find the API reference at `Development resources for OpenStack clouds -`_. +`_. You must choose whether you want to support the Amazon EC2 compatibility APIs, or just the OpenStack APIs. One issue you might encounter when @@ -273,7 +273,7 @@ Extensions ~~~~~~~~~~ The `API -Specifications `_ define +Specifications `_ define the core actions, capabilities, and mediatypes of the OpenStack API. A client can always depend on the availability of this core API, and implementers are always required to support it in its entirety. diff --git a/doc/ops-guide/source/ops-lay-of-the-land.rst b/doc/ops-guide/source/ops-lay-of-the-land.rst index 390e137954..a195b4ea7f 100644 --- a/doc/ops-guide/source/ops-lay-of-the-land.rst +++ b/doc/ops-guide/source/ops-lay-of-the-land.rst @@ -250,7 +250,7 @@ token. http://203.0.113.10:8774/v2.0/98333aba48e756fa8f629c83a818ad57/servers | jq . To discover how API requests should be structured, read the `OpenStack -API Reference `_. To chew +API Reference `_. To chew through the responses using jq, see the `jq Manual `_. diff --git a/doc/ops-guide/source/preface.rst b/doc/ops-guide/source/preface.rst index ce65f8dd17..d816cdcf4a 100644 --- a/doc/ops-guide/source/preface.rst +++ b/doc/ops-guide/source/preface.rst @@ -177,7 +177,7 @@ Installation Tutorials and Guides This guide targets OpenStack administrators seeking to deploy and manage OpenStack Networking (neutron). -`OpenStack API Guide `_ +`OpenStack API Guide `_ A brief overview of how to send REST API requests to endpoints for OpenStack services