openstack/api-site
Code Issues Proposed changes

use https for api-quick-start

Browse Source 
We now have https at docs.o.o and developer.o.o, use it.

Also, fix a few outdated URLs.

Change-Id: Ia91ed8380bfac44479428baf491a25750defd1ff
This commit is contained in:
Andreas Jaeger 2017-01-27 10:39:43 +01:00
parent c20f78cc69
commit 36067cf921
3 changed files with 39 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-quick-start/setup.cfg
View File

@ -5,7 +5,7 @@ description-file =
README.rst
author = OpenStack Documentation
author-email = openstack-docs@lists.openstack.org
home-page = http://developer.openstack.org/
home-page = https://developer.openstack.org/
classifier =
Intended Audience :: Developers
License :: OSI Approved :: Apache Software License

18
api-quick-start/source/api-quick-start.rst
View File

@ -36,7 +36,7 @@ Authentication and API request workflow
The examples in this section use cURL commands. For information about cURL,
see http://curl.haxx.se/. For information about the OpenStack APIs, see
`OpenStack API Reference <http://developer.openstack.org/api-ref.html>`__.
:ref:`current_api_versions`.
.. _authenticate:
@ -340,7 +340,7 @@ Send API requests
This section shows how to make some basic Compute API calls. For a complete
list of Compute API calls, see
`Compute API <http://developer.openstack.org/api-ref/compute/>`__.
`Compute API <https://developer.openstack.org/api-ref/compute/>`__.
Export the token ID to the ``OS_TOKEN`` environment variable. For example:
@ -352,7 +352,7 @@ The token expires every hour by default,
though it can be configured differently - see
the ``expiration`` option in the
``Description of token configuration options`` section of the
`Identity Service Configuration <http://docs.openstack.org/mitaka/config-reference/identity/options.html#keystone-token>`__ page.
`Identity Service Configuration <https://docs.openstack.org/newton/config-reference/identity/options.html#keystone-token>`__ page.
Export the tenant name to the ``OS_PROJECT_NAME`` environment variable. For example:
@ -599,7 +599,7 @@ interface. Also, each OpenStack project has a related client project that
includes Python API bindings and a command-line interface (CLI).
For information about the command-line clients, see `OpenStack
Command-Line Interface Reference <http://docs.openstack.org/cli-reference/>`__.
Command-Line Interface Reference <https://docs.openstack.org/cli-reference/>`__.
Install the clients
-------------------
@ -642,9 +642,9 @@ Before you can issue client commands, you must download and source the
``openrc`` file to set environment variables.
For complete information about the OpenStack clients, including how to source
the ``openrc`` file, see `OpenStack End User Guide <http://docs.openstack.org/user-guide/>`__,
`OpenStack Administrator Guide <http://docs.openstack.org/admin-guide/>`__,
and `OpenStack Command-Line Interface Reference <http://docs.openstack.org/cli-reference/>`__.
the ``openrc`` file, see `OpenStack End User Guide <https://docs.openstack.org/user-guide/>`__,
`OpenStack Administrator Guide <https://docs.openstack.org/admin-guide/>`__,
and `OpenStack Command-Line Interface Reference <https://docs.openstack.org/cli-reference/>`__.
Launch an instance
------------------
@ -732,6 +732,6 @@ command with the image and flavor IDs and the server name:
.. note::
For information about the default ports that the OpenStack components use,
see `Firewalls and default ports <http://docs.openstack.org/liberty/
config-reference/content/firewalls-default-ports.html>`_ in the
see `Firewalls and default ports <https://docs.openstack.org/newton/config-reference/firewalls-default-ports.html>`_
in the
*OpenStack Configuration Reference*.

56
api-quick-start/source/index.rst
View File

@ -6,50 +6,52 @@ Use the OpenStack APIs to launch server instances, create images, assign
metadata to instances and images, create storage containers and objects, and
complete other actions in your OpenStack cloud.
.. _current_api_versions:
Current API versions
--------------------
`Bare Metal API v1 <http://developer.openstack.org/api-ref/baremetal/>`__ (microversions)
`Bare Metal API v1 <https://developer.openstack.org/api-ref/baremetal/>`__ (microversions)
`Block Storage API v3 <http://developer.openstack.org/api-ref/block-storage/v3/>`__ (microversions)
`Block Storage API v3 <https://developer.openstack.org/api-ref/block-storage/v3/>`__ (microversions)
.. note:: The Block Storage API v3 is functionally identical to the
Block Storage API v2. Subsequent API v3 microversions, such as v3.1,
differ from API v2.
`Clustering API v1 <http://developer.openstack.org/api-ref/clustering/>`__
`Clustering API v1 <https://developer.openstack.org/api-ref/clustering/>`__
`Compute API <http://developer.openstack.org/api-ref/compute/>`__ (microversions)
`Compute API <https://developer.openstack.org/api-ref/compute/>`__ (microversions)
`Container Infrastructure Management API <http://developer.openstack.org/api-ref/container-infrastructure-management/>`__ (microversions)
`Container Infrastructure Management API <https://developer.openstack.org/api-ref/container-infrastructure-management/>`__ (microversions)
`Data Processing v1.1 <http://developer.openstack.org/api-ref/data-processing/>`__
`Data Processing v1.1 <https://developer.openstack.org/api-ref/data-processing/>`__
`Data Protection Orchestration v1 <http://developer.openstack.org/api-ref/data-protection-orchestration/>`__
`Data Protection Orchestration v1 <https://developer.openstack.org/api-ref/data-protection-orchestration/>`__
`Database Service API v1.0 <http://developer.openstack.org/api-ref/database/>`__
`Database Service API v1.0 <https://developer.openstack.org/api-ref/database/>`__
`Domain Name Server (DNS) API v2 <http://developer.openstack.org/api-ref/dns/>`__
`Domain Name Server (DNS) API v2 <https://developer.openstack.org/api-ref/dns/>`__
`EC2 API Service <http://developer.openstack.org/api-ref/ec2-api/>`__
`EC2 API Service <https://developer.openstack.org/api-ref/ec2-api/>`__
`Identity API v3 <http://developer.openstack.org/api-ref/identity/v3>`__
`Identity API v3 <https://developer.openstack.org/api-ref/identity/v3>`__
`Identity API v3 extensions <http://developer.openstack.org/api-ref/identity/v3-ext>`__
`Identity API v3 extensions <https://developer.openstack.org/api-ref/identity/v3-ext>`__
`Image service API v2 <http://developer.openstack.org/api-ref/image/v2>`__
`Image service API v2 <https://developer.openstack.org/api-ref/image/v2>`__
`Messaging API v2 <http://developer.openstack.org/api-ref/messaging>`__
`Messaging API v2 <https://developer.openstack.org/api-ref/messaging>`__
`Networking API v2.0 <http://developer.openstack.org/api-ref/networking/v2>`__
`Networking API v2.0 <https://developer.openstack.org/api-ref/networking/v2>`__
`Object Storage API v1 <http://developer.openstack.org/api-ref/object-storage>`__
`Object Storage API v1 <https://developer.openstack.org/api-ref/object-storage>`__
`Orchestration API v1 <http://developer.openstack.org/api-ref/orchestration/v1/>`__
`Orchestration API v1 <https://developer.openstack.org/api-ref/orchestration/v1/>`__
`Search API v1 <http://developer.openstack.org/api-ref/search>`__
`Search API v1 <https://developer.openstack.org/api-ref/search>`__
`Shared File Systems API v2 <http://developer.openstack.org/api-ref/shared-file-systems>`__ (microversions)
`Shared File Systems API v2 <https://developer.openstack.org/api-ref/shared-file-systems>`__ (microversions)
.. note:: The Shared File Systems API v1 is functionally identical to the
Shared File Systems API v2. Subsequent API v2 microversions, such as v2.1,
@ -58,20 +60,20 @@ Current API versions
Supported API versions
----------------------
`Block Storage API v2 <http://developer.openstack.org/api-ref/block-storage/v2/>`__
`Block Storage API v2 <https://developer.openstack.org/api-ref/block-storage/v2/>`__
Deprecated API versions
-----------------------
`Block Storage API v1 <http://developer.openstack.org/api-ref/block-storage/v1/>`__
`Block Storage API v1 <https://developer.openstack.org/api-ref/block-storage/v1/>`__
`Identity API v2.0 <http://developer.openstack.org/api-ref/identity/v2>`__
`Identity API v2.0 <https://developer.openstack.org/api-ref/identity/v2>`__
`Identity admin API v2.0 <http://developer.openstack.org/api-ref/identity/v2-admin>`__
`Identity admin API v2.0 <https://developer.openstack.org/api-ref/identity/v2-admin>`__
`Identity API v2.0 extensions <http://developer.openstack.org/api-ref/identity/v2-ext>`__
`Identity API v2.0 extensions <https://developer.openstack.org/api-ref/identity/v2-ext>`__
`Image service API v1 <http://developer.openstack.org/api-ref/image/v1>`__
`Image service API v1 <https://developer.openstack.org/api-ref/image/v1>`__
.. todo: telemetry link
@ -90,7 +92,7 @@ The API status reflects the state of the endpoint on the service.
information about API status values and version information, see
`Version Discovery <https://wiki.openstack.org/wiki/VersionDiscovery>`__.
* Microversions indicates that the API follows a `pattern established by
the Compute service <http://developer.openstack.org/api-guide/compute/microversions.html>`__ to
the Compute service <https://developer.openstack.org/api-guide/compute/microversions.html>`__ to
enable small, documented changes to the API on a resource-by-resource
basis.
@ -135,7 +137,7 @@ To begin sending API requests, use one of the following methods:
automation tasks in Python by making calls on Python objects rather
than making REST calls directly. All OpenStack command-line tools are
implemented by using the Python SDK. See `OpenStack Python
SDK <http://docs.openstack.org/user-guide/sdk.html>`__ in the
SDK <https://docs.openstack.org/user-guide/sdk.html>`__ in the
*OpenStack End User Guide*.
.. toctree::