From da4009d8ada28e2901ede24d290d082515159fd7 Mon Sep 17 00:00:00 2001 From: Fei Long Wang Date: Mon, 18 Apr 2016 13:15:38 +1200 Subject: [PATCH] Init commit to add API ref in tree This patches adds the basic architecture to adopt api ref in tree and a new tox command to build api ref for testing. A new api ref gate job will be added to verify the format which will be tracked by another commit against project-config. blueprint: api-ref-in-tree Change-Id: Idffbdc9325868a3dcd6a9bd7f90f030fd52ee0dc --- api-ref/source/conf.py | 217 ++++++++++++++++++ api-ref/source/index.rst | 22 ++ api-ref/source/v2/index.rst | 20 ++ api-ref/source/v2/parameters.yaml | 16 ++ api-ref/source/v2/queues.inc | 0 api-ref/source/versions/index.rst | 20 ++ api-ref/source/versions/parameters.yaml | 8 + .../samples/versions-list-response.json | 55 +++++ api-ref/source/versions/versions.inc | 35 +++ test-requirements.txt | 1 + tox.ini | 18 +- 11 files changed, 411 insertions(+), 1 deletion(-) create mode 100644 api-ref/source/conf.py create mode 100644 api-ref/source/index.rst create mode 100644 api-ref/source/v2/index.rst create mode 100644 api-ref/source/v2/parameters.yaml create mode 100644 api-ref/source/v2/queues.inc create mode 100644 api-ref/source/versions/index.rst create mode 100644 api-ref/source/versions/parameters.yaml create mode 100644 api-ref/source/versions/samples/versions-list-response.json create mode 100644 api-ref/source/versions/versions.inc diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py new file mode 100644 index 000000000..6a5278bf8 --- /dev/null +++ b/api-ref/source/conf.py @@ -0,0 +1,217 @@ +# -*- coding: utf-8 -*- +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +# +# nova documentation build configuration file, created by +# sphinx-quickstart on Sat May 1 15:17:47 2010. +# +# This file is execfile()d with the current directory set to +# its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import os +import subprocess +import sys + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('../../')) +sys.path.insert(0, os.path.abspath('../')) +sys.path.insert(0, os.path.abspath('./')) + +# -- General configuration ---------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. + +extensions = [ + 'os_api_ref', + 'oslosphinx', +] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +# +# source_encoding = 'utf-8' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Messaging Service API Reference' +copyright = u'2010-present, OpenStack Foundation' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +from zaqar.version import version_info +# The full version, including alpha/beta/rc tags. +release = version_info.release_string() +# The short X.Y version. +version = version_info.version_string() + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# The reST default role (used for this markup: `text`) to use +# for all documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +add_module_names = False + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# -- Options for man page output ---------------------------------------------- + +# Grouping the document tree for man pages. +# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual' + + +# -- Options for HTML output -------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +# html_theme_path = ["."] +# html_theme = '_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +# html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' +git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", + "-n1"] +html_last_updated_fmt = subprocess.Popen( + git_cmd, stdout=subprocess.PIPE).communicate()[0] + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_use_modindex = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = '' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'zaqardoc' + + +# -- Options for LaTeX output ------------------------------------------------- + +# The paper size ('letter' or 'a4'). +# latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +# latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass +# [howto/manual]). +latex_documents = [ + ('index', 'Zaqar.tex', u'OpenStack Messaging Service API Documentation', + u'OpenStack Foundation', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# Additional stuff for the LaTeX preamble. +# latex_preamble = '' + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_use_modindex = True diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst new file mode 100644 index 000000000..0a5db8d6d --- /dev/null +++ b/api-ref/source/index.rst @@ -0,0 +1,22 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +====================== +Messaging Service APIs +====================== + +.. toctree:: + :maxdepth: 1 + + versions/index + v2/index \ No newline at end of file diff --git a/api-ref/source/v2/index.rst b/api-ref/source/v2/index.rst new file mode 100644 index 000000000..5bc8db7a4 --- /dev/null +++ b/api-ref/source/v2/index.rst @@ -0,0 +1,20 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +:tocdepth: 2 + +================================== +Messaging Service API v2 (CURRENT) +================================== + +.. include:: queues.inc diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml new file mode 100644 index 000000000..39e9e0584 --- /dev/null +++ b/api-ref/source/v2/parameters.yaml @@ -0,0 +1,16 @@ +#### variables in header###################################################### + +client_id: + type: UUID + in: header + description: | + A unique ID for indicating where the request come from. + +#### variables in path ####################################################### + +queue_name: + type: string + in: path + required: True + description: | + The name of the queue. \ No newline at end of file diff --git a/api-ref/source/v2/queues.inc b/api-ref/source/v2/queues.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/versions/index.rst b/api-ref/source/versions/index.rst new file mode 100644 index 000000000..14b0e5a77 --- /dev/null +++ b/api-ref/source/versions/index.rst @@ -0,0 +1,20 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +:tocdepth: 2 + +========================== +Messaging Service Versions +========================== + +.. include:: versions.inc \ No newline at end of file diff --git a/api-ref/source/versions/parameters.yaml b/api-ref/source/versions/parameters.yaml new file mode 100644 index 000000000..2a94a34c5 --- /dev/null +++ b/api-ref/source/versions/parameters.yaml @@ -0,0 +1,8 @@ +#### variables in response#################################################### + +versions: + type: list + in: body + required: True + description: | + A list of supported major API versions. \ No newline at end of file diff --git a/api-ref/source/versions/samples/versions-list-response.json b/api-ref/source/versions/samples/versions-list-response.json new file mode 100644 index 000000000..fcd4a6cce --- /dev/null +++ b/api-ref/source/versions/samples/versions-list-response.json @@ -0,0 +1,55 @@ +{ + "versions":[ + { + "status":"DEPRECATED", + "updated":"2014-9-11T17:47:05Z", + "media-types":[ + { + "base":"application/json", + "type":"application/vnd.openstack.messaging-v1+json" + } + ], + "id":"1", + "links":[ + { + "href":"/v1/", + "rel":"self" + } + ] + }, + { + "status":"SUPPORTED", + "updated":"2014-9-24T04:06:47Z", + "media-types":[ + { + "base":"application/json", + "type":"application/vnd.openstack.messaging-v1_1+json" + } + ], + "id":"1.1", + "links":[ + { + "href":"/v1.1/", + "rel":"self" + } + ] + }, + { + "status":"CURRENT", + "updated":"2014-9-24T04:06:47Z", + "media-types":[ + { + "base":"application/json", + "type":"application/vnd.openstack.messaging-v2+json" + } + ], + "id":"2", + "links":[ + { + "href":"/v2/", + "rel":"self" + } + ] + } + ] +} \ No newline at end of file diff --git a/api-ref/source/versions/versions.inc b/api-ref/source/versions/versions.inc new file mode 100644 index 000000000..5907fe662 --- /dev/null +++ b/api-ref/source/versions/versions.inc @@ -0,0 +1,35 @@ +============ +API Versions +============ + +Concepts +======== + +The Zaqar API only supports ''major versions'' expressed in request URLs. + + +List Major Versions +=================== + +.. rest_method:: GET / + +This fetches all the information about all known major API versions in +the deployment. Links to more specific information will be provided +for each API version. + + +Normal response codes: 300 +Error response codes: serviceUnavailable (503) + +Response Parameters +------------------- + +.. rest_parameters:: parameters.yaml + + - versions: versions + +Response Example +---------------- + +.. literalinclude:: samples/versions-list-response.json + :language: javascript diff --git a/test-requirements.txt b/test-requirements.txt index 67437037c..ee5b0f93a 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -26,6 +26,7 @@ oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0 openstack-doc-tools>=0.23 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 reno>=1.6.2 # Apache2 +os-api-ref>=0.1.0 # Apache-2.0 # Tempest tempest>=11.0.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 887865e99..21d65c64c 100644 --- a/tox.ini +++ b/tox.ini @@ -44,7 +44,23 @@ commands = commands = {posargs} [testenv:docs] -commands = python setup.py build_sphinx +commands = + python setup.py build_sphinx + sphinx-build -b html api-ref/source api-ref/build/html + +[testenv:api-ref] +# This environment is called from CI scripts to test and publish +# the API Ref to developer.openstack.org. +# +# NOTE(sdague): this target does not use constraints because +# upstream infra does not yet support it. Once that's fixed, we can +# drop the install_command. +whitelist_externals = bash + rm +install_command = pip install -U --force-reinstall {opts} {packages} +commands = + rm -rf api-ref/build + sphinx-build -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html [testenv:debug] commands = oslo_debug_helper {posargs}