diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py new file mode 100644 index 0000000..9d2259a --- /dev/null +++ b/api-ref/source/conf.py @@ -0,0 +1,232 @@ +# -*- 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 + +import openstackdocstheme + +html_theme = 'openstackdocs' +html_theme_path = [openstackdocstheme.get_html_theme_path()] +html_theme_options = { + "sidebar_mode": "toc", +} + +extensions = [ + 'os_api_ref', +] + +# 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. + +# 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'Billing 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 distil.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() + +# Config logABug feature +giturl = u'http://git.openstack.org/cgit/openstack/distil/tree/api-ref/source' +# source tree +# html_context allows us to pass arbitrary values into the html template +html_context = {'bug_tag': 'api-ref', + 'giturl': giturl, + 'bug_project': 'distil'} + +# 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 = 'distildoc' + + +# -- 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', 'Distil.tex', u'OpenStack Billing 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 0000000..ac94d5c --- /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. + +:tocdepth: 2 + +================================ +Billing Service API v2 (CURRENT) +================================ + +.. rest_expand_all:: + +.. include:: products.inc diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml new file mode 100644 index 0000000..d35a2ef --- /dev/null +++ b/api-ref/source/parameters.yaml @@ -0,0 +1,8 @@ +# variables in path +regions: + description: | + The regions list to request products. Separated with comma, for example: + /v2/products?regions=region1,regions2 + in: path + required: false + type: string diff --git a/api-ref/source/products.inc b/api-ref/source/products.inc new file mode 100644 index 0000000..e832dec --- /dev/null +++ b/api-ref/source/products.inc @@ -0,0 +1,34 @@ +=================== +Products (products) +=================== +Product is the resource cloud provider can charge the tenant users. + +List products +============= + +.. rest_method:: GET /v2/products + +Lists products. + +This operation lists products and the price, unit information of each product. + +Normal response codes: 200 + +Error response codes: + +- BadRequest (400) +- ServiceUnavailable (503) + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - regions: regions + + +Response Example +---------------- + +.. literalinclude:: samples/get-products-response.json + :language: javascript \ No newline at end of file diff --git a/api-ref/source/samples/get-products-response.json b/api-ref/source/samples/get-products-response.json new file mode 100644 index 0000000..466240a --- /dev/null +++ b/api-ref/source/samples/get-products-response.json @@ -0,0 +1,56 @@ +{ + "products": { + "nz-por-1": { + "compute": [ + { + "price": 0.711, + "resource": "c1.c16r16", + "description": "16 vCPU, 16 GB RAM", + "unit": "hour" + }, + ], + "network": [ + { + "price": 0.006, + "resource": "n1.ipv4", + "description": "Floating public IP (IPv4)", + "unit": "hour" + }, + ], + "block storage": [ + { + "price": 0.0005, + "resource": "b1.standard", + "description": "Standard tier", + "unit": "gigabyte" + } + ] + }, + "nz-hlz-1": { + "compute": [ + { + "price": 0.711, + "resource": "c1.c16r16", + "description": "16 vCPU, 16 GB RAM", + "unit": "hour" + }, + ], + "network": [ + { + "price": 0.006, + "resource": "n1.ipv4", + "description": "Floating public IP (IPv4)", + "unit": "hour" + }, + ], + "block storage": [ + { + "price": 0.0005, + "resource": "b1.standard", + "description": "Standard tier", + "unit": "gigabyte" + } + ] + } + } +} diff --git a/requirements.txt b/requirements.txt index d9ffbc6..ec30c5c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,7 +4,7 @@ # requirements. Babel>=2.3.4,!=2.4.0 # BSD -Flask<1.0,>=0.10 # BSD +Flask>=0.10,!=0.11,<1.0 # BSD pbr>=1.6 # Apache-2.0 six>=1.9.0 # MIT odoorpc==0.4.2 diff --git a/test-requirements.txt b/test-requirements.txt index 1fcb54d..3e415f5 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,7 +1,6 @@ hacking>=0.12.0,!=0.13.0,<0.14 # Apache-2.0 coverage>=4.0,!=4.4 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD -oslotest>=1.10.0 # Apache-2.0 pylint==1.4.5 # GPLv2 sqlalchemy-migrate>=0.11.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD @@ -13,4 +12,7 @@ Flask>=0.10,!=0.11,<1.0 # BSD sphinx>=1.6.2 # BSD sphinxcontrib-httpdomain -openstackdocstheme>=1.11.0 # Apache-2.0 \ No newline at end of file +openstackdocstheme>=1.17.0 # Apache-2.0 +oslosphinx>=4.7.0 # Apache-2.0 +oslotest>=1.10.0 # Apache-2.0 +os-api-ref>=1.4.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 1fa04a8..a65a9a6 100644 --- a/tox.ini +++ b/tox.ini @@ -35,10 +35,17 @@ commands = {posargs} [testenv:docs] commands = - rm -rf doc/html doc/build - rm -rf doc/source/apidoc doc/source/api python setup.py build_sphinx +[testenv:api-ref] +# This environment is called from CI scripts to test and publish +# the API Ref to developer.openstack.org. +# +whitelist_externals = bash + rm +commands = + rm -rf api-ref/build + sphinx-build -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html [testenv:pylint] setenv = VIRTUAL_ENV={envdir} commands = bash tools/lintstack.sh