diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f442a8ce33..a9864b8b59 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -143,59 +143,14 @@ process. Trove Documentation =================== -This repository also contains the following OpenStack manual: +This repository also contains the Database Services API Reference. +To build the API reference, run:: -* Database Services API Reference + $ tox -e api-ref -Prerequisites for Building the Documentation --------------------------------------------- -`Apache Maven `_ must be installed to build the -documentation. +The generated documentation is found:: -To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later:: - - apt-get install maven - -On Fedora 15 and later:: - - yum install maven3 - -Building --------- -The manuals are in the ``apidocs`` directory. - -To build a specific guide, look for a ``pom.xml`` file within a subdirectory, -then run the ``mvn`` command in that directory. For example:: - - cd apidocs - mvn clean generate-sources - -The generated PDF documentation file is:: - - apidocs/target/docbkx/webhelp/cdb-devguide/cdb-devguide-reviewer.pdf - -The root of the generated HTML documentation is:: - - apidocs/target/docbkx/webhelp/cdb-devguide/content/index.html - -Testing of changes and building of the manual ----------------------------------------------- - -Install the python tox package and run ``tox`` from the top-level -directory to use the same tests that are done as part of our Jenkins -gating jobs. - -If you like to run individual tests, run: - - * ``tox -e checkniceness`` - to run the niceness tests - * ``tox -e checksyntax`` - to run syntax checks - * ``tox -e checkdeletions`` - to check that no deleted files are referenced - * ``tox -e checkbuild`` - to actually build the manual - -tox will use the `openstack-doc-tools package -`_ for execution of -these tests. openstack-doc-tools has a requirement on maven for the -build check. + api-ref/html/index.html Testing ======= diff --git a/api-ref/source/api-versions.inc b/api-ref/source/api-versions.inc new file mode 100644 index 0000000000..6af3ea03c2 --- /dev/null +++ b/api-ref/source/api-versions.inc @@ -0,0 +1,76 @@ +.. -*- rst -*- + +============ +API versions +============ + +Lists information for all Database Service API versions and shows +Database Service v1.0 details. + + +List versions +============= + +.. rest_method:: GET / + +Lists information about all Database Service API versions. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + + +Response Example +---------------- + +.. literalinclude:: samples/db-versions-response.json + :language: javascript + + + + + + + + + + + + + + +Show version details +==================== + +.. rest_method:: GET /v1.0 + +Shows details for the Database Service API v1.0. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-version-response.json + :language: javascript + + + + + + + + + + + + + diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py new file mode 100755 index 0000000000..ef1e360266 --- /dev/null +++ b/api-ref/source/conf.py @@ -0,0 +1,222 @@ +# -*- 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. +# +# trove 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 warnings + +# 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'Database 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 trove.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"] +try: + html_last_updated_fmt = subprocess.Popen( + git_cmd, stdout=subprocess.PIPE).communicate()[0] +except Exception: + warnings.warn('Cannot get last updated time from git repository. ' + 'Not setting "html_last_updated_fmt".') + +# 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 = 'trovedoc' + + +# -- 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', 'Trove.tex', u'OpenStack Database 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/configurations.inc b/api-ref/source/configurations.inc new file mode 100644 index 0000000000..734f2fd03c --- /dev/null +++ b/api-ref/source/configurations.inc @@ -0,0 +1,313 @@ +.. -*- rst -*- + +===================================== +Configuration groups (configurations) +===================================== + +Creates and lists all configuration groups. + + +Create configuration group +========================== + +.. rest_method:: POST /v1.0/{accountId}/configurations + +Creates a configuration group. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - datastore: datastore + - values: values + - name: name + - accountId: accountId + +Request Example +--------------- + +.. literalinclude:: samples/db-create-config-group-request.json + :language: javascript + + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-create-config-group-response.json + :language: javascript + + + + + + + + + + + + + + +List configuration groups +========================= + +.. rest_method:: GET /v1.0/{accountId}/configurations + +Lists all configuration groups. + +The list includes the associated data store and data store version +for each configuration group. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-list-cfg-groups-response.json + :language: javascript + + + + + + + + + + + + + + +List configuration group instances +================================== + +.. rest_method:: GET /v1.0/{accountId}/configurations/{configId}/instances + +Lists the instances associated with the specified configuration group. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - configId: configId + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-config-group-instances-response.json + :language: javascript + + + + + + + + + + + + + + +Delete configuration group +========================== + +.. rest_method:: DELETE /v1.0/{accountId}/configurations/{configId} + +Deletes a configuration group. + +Error response codes:202,413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - configId: configId + - accountId: accountId + + + + + + + + + + + + + + + + +Patch configuration group +========================= + +.. rest_method:: PATCH /v1.0/{accountId}/configurations/{configId} + +Sets new values for a configuration group. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - values: values + - configId: configId + - accountId: accountId + +Request Example +--------------- + +.. literalinclude:: samples/db-patch-config-group-request.json + :language: javascript + + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-patch-config-group-response-json-http.txt + :language: javascript + + + + + + + + + + + + + + +Show configuration group details +================================ + +.. rest_method:: GET /v1.0/{accountId}/configurations/{configId} + +Lists details about a configuration group, including its values. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - configId: configId + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-config-group-details-response.json + :language: javascript + + + + + + + + + + + + + + +Update configuration group +========================== + +.. rest_method:: PUT /v1.0/{accountId}/configurations/{configId} + +Sets new values for a configuration group. Also lets you change the name and description of the configuration group. + +Error response codes:202,413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - values: values + - description: description + - name: name + - configId: configId + - accountId: accountId + +Request Example +--------------- + +.. literalinclude:: samples/db-update-config-group-request.json + :language: javascript + + + + + + + + + + + + + + + + diff --git a/api-ref/source/database-instance-actions.inc b/api-ref/source/database-instance-actions.inc new file mode 100644 index 0000000000..f1c842a83a --- /dev/null +++ b/api-ref/source/database-instance-actions.inc @@ -0,0 +1,269 @@ +.. -*- rst -*- + +================================== +Database instance actions (action) +================================== + +Resizes instances and volumes and restarts instances. + + +Restart instance +================ + +.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/action + +Restarts the database service for an instance. + +The restart operation restarts only the MySQL instance. Restarting +MySQL erases any dynamic configuration settings that you make in +MySQL. + +The MySQL service is unavailable until the instance restarts. + +If the operation succeeds, it returns the ``Accepted (202)`` +response code. + +Error response codes:202,413,415,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + +Request Example +--------------- + +.. literalinclude:: samples/db-instance-restart-request.json + :language: javascript + + + + + + + + + + + + + + + + + + +Resize instance +=============== + +.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/action + +Resizes the memory for an instance. + +If you provide a valid ``flavorRef``, this operation changes the +memory size of the instance, and restarts MySQL. + +Error response codes:202,413,415,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + +Request Example +--------------- + +.. literalinclude:: samples/db-instance-resize-instance-request.json + :language: javascript + + + + + + + + + + + + + + + + + + +Resize instance volume +====================== + +.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/action + +Resizes the volume that is attached to an instance. + +You can use this operation to increase but not decrease the volume +size. A valid volume size is an integer value in gigabytes (GB). + +You cannot increase the volume to a size that is larger than the +API volume size limit. + +If this operation succeeds, it returns a 202 Accepted response. + +Error response codes:202,413,415,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + +Request Example +--------------- + +.. literalinclude:: samples/db-instance-resize-volume-request.json + :language: javascript + + + + + + + + + + + + + + + + + + +Promote instance to replica source +================================== + +.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/action + +Promotes a replica. + +If you have set up replication, and the base instance is still +reachable, you can use this operation to promote a replica to be +the new base instance. + +This can be useful if you want to make a configuration change to +the base instance that your replicas are replicating from. For +example, you might want to increase the disk or CPU capacity. If +you made the change on the base instance directly, you would need +to take the base instance down for the duration of the operation. +Instead, you can create a replica, make the configuration change on +the replica, and then promote the replica to become the new base +instance. + +For ``instanceId``, pass in the instance ID of the replica you want +to promote. + +Error response codes:202,413,415,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + +Request Example +--------------- + +.. literalinclude:: samples/db-instance-promote-replica-request.json + :language: javascript + + + + + + + + + + + + + + + + + + +Delete replication base instance +================================ + +.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/action + +Deletes the base instance in a replication set. + +If the base instance becomes unreachable, you can use this +operation to delete the base instance. + +This operation: + +- Finds the replica that has processed the greatest number of + transactions and picks that replica to use as the new base + instance. + +- Transfers the public IP of the old base instance to the new base + instance (which is the newly-promoted replica). + +- Deletes the old base instance. + +- Takes all the instances in the replication set and makes them + start replicating from the new base instance. + +For ``instanceId``, pass in the instance ID of the unreachable base +instance. + +Error response codes:202,413,415,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + +Request Example +--------------- + +.. literalinclude:: samples/db-instance-eject-replica-request.json + :language: javascript + + + + + + + + + + + + + + + + + diff --git a/api-ref/source/database-instances.inc b/api-ref/source/database-instances.inc new file mode 100644 index 0000000000..7dd9f8f089 --- /dev/null +++ b/api-ref/source/database-instances.inc @@ -0,0 +1,425 @@ +.. -*- rst -*- + +============================== +Database instances (instances) +============================== + +Creates, lists, shows details for, attaches a configuration group +to, detaches a configuration group from, deletes, lists +configuration defaults, creates root, and determines whether root +is enables for instances. + + +Delete database instance +======================== + +.. rest_method:: DELETE /v1.0/{accountId}/instances/{instanceId} + +Deletes a database instance, including any associated data. + +This operation does not delete any read slaves. + +You cannot complete this operation when the instance state is +either ``REBUILDING`` or ``BUILDING``. + +Error response codes:202,413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + + + + + + + + + + + + + + + + +Show database instance details +============================== + +.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId} + +Shows database instance details. + +Lists the status and details of the database instance. + +Lists the volume size in gigabytes (GB) and the approximate GB +used. + +After instance creation, the ``used`` value is greater than 0, +which is expected and due to the automatic creation of non-empty +transaction logs for MySQL optimization. The response does not +include the ``used`` attribute when the instance status is +``BUILD``, ``REBOOT``, ``RESIZE``, or ``ERROR``. + +The list operations return a DNS-resolvable host name for the +database instance rather than an IP address. Because the host name +always resolves to the correct IP address for the database +instance, you do not need to maintain the mapping. Although the IP +address might change when you resize, migrate, or perform other +operations, the host name always resolves to the correct database +instance. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-instance-status-detail-response.json + :language: javascript + + + + + + + + + + + + + + +Attach configuration group +========================== + +.. rest_method:: PUT /v1.0/{accountId}/instances/{instanceId} + +Attaches a configuration group to an instance. + +Error response codes:202,413,415,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - configuration: configuration + - instanceId: instanceId + - accountId: accountId + +Request Example +--------------- + +.. literalinclude:: samples/db-attach-config-group-request.json + :language: javascript + + + + + + + + + + + + + + + + + + +Detach configuration group +========================== + +.. rest_method:: PUT /v1.0/{accountId}/instances/{instanceId} + +Detaches a configuration group from an instance. + +When you pass in only an instance ID and omit the configuration ID, +this operation detaches any configuration group that was attached +to the instance. + +Error response codes:202,413,415,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - configuration: configuration + - instanceId: instanceId + - accountId: accountId + +Request Example +--------------- + +.. literalinclude:: samples/db-detach-config-group-request.json + :language: javascript + + + + + + + + + + + + + + + + + + +Detach replica +============== + +.. rest_method:: PATCH /v1.0/{accountId}/instances/{instanceId} + +Detaches a replica from its replication source. + +If you created an instance that is a replica of a source instance, +you can detach the replica from the source. This can be useful if +the source becomes unavailable. In this case, you can detach the +replica from the source, making the replica a standalone database +instance. You can then take the new standalone instance and create +a new replica of that instance. + +Error response codes:202,413,415,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - replica_of: replica_of + - slave_of: slave_of + - instanceId: instanceId + - accountId: accountId + +Request Example +--------------- + +.. literalinclude:: samples/db-detach-replica-request.json + :language: javascript + + + + + + + + + + + + + + + + + + +Create database instance +======================== + +.. rest_method:: POST /v1.0/{accountId}/instances + +Creates a database instance. + +Asynchronously provisions a database instance. You must specify a +flavor and a volume size. The service provisions the instance with +a volume of the requested size, which serves as storage for the +database instance. + + **Notes** + +- You can create only one database instance per POST request. + +- You can create a database instance with one or more databases. You + associate users with each database. + +- The default binding for the MySQL instance is port 3306. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - users: users + - password: password + - datastore_version: datastore_version + - name: name + - flavorRef: flavorRef + - characterSet: characterSet + - replica_count: replica_count + - instance: instance + - collate: collate + - databases: databases + - datastore: datastore + - configuration: configuration + - type: type + - replica_of: replica_of + - size: size + - accountId: accountId + +Request Example +--------------- + +.. literalinclude:: samples/db-create-instance-request.json + :language: javascript + + + +Response Parameters +------------------- + +.. rest_parameters:: parameters.yaml + + - updated: updated + - name: name + - created: created + - characterSet: characterSet + - instance: instance + - collate: collate + - databases: databases + - flavor: flavor + - users: users + + + +Response Example +---------------- + +.. literalinclude:: samples/db-create-instance-response.json + :language: javascript + + + + + + + + + + + + + + +List database instances +======================= + +.. rest_method:: GET /v1.0/{accountId}/instances + +Lists information, including status, for all database instances. + +Lists status and information for all database instances. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-instances-index-response.json + :language: javascript + + + + + + + + + + + + + + +List configuration defaults +=========================== + +.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/configuration + +Lists the configuration defaults for an instance. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-list-cfg-defaults-response.json + :language: javascript + + + + + + + + + + + + + diff --git a/api-ref/source/databases.inc b/api-ref/source/databases.inc new file mode 100644 index 0000000000..658b5b7be1 --- /dev/null +++ b/api-ref/source/databases.inc @@ -0,0 +1,137 @@ +.. -*- rst -*- + +===================== +Databases (databases) +===================== + +Creates, lists all, and deletes databases. + + +Delete database +=============== + +.. rest_method:: DELETE /v1.0/{accountId}/instances/{instanceId}/databases/{databaseName} + +Deletes a database. + +This operation also deletes all data that is associated with the +database. + +Error response codes:202,413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - databaseName: databaseName + - accountId: accountId + + + + + + + + + + + + + + + + +Create database +=============== + +.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/databases + +Creates a database within an instance. + +The ``name`` of the database is a required attribute. + +Error response codes:202,413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - characterSet: characterSet + - collate: collate + - name: name + - instanceId: instanceId + - accountId: accountId + +Request Example +--------------- + +.. literalinclude:: samples/db-create-databases-request.json + :language: javascript + + + + + + + + + + + + + + + + + +List instance databases +======================= + +.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/databases + +Lists databases for an instance. + +This operation returns only the user-defined databases and not the +system databases. Only the database administrator can view the +``mysql``, ``information_schema``, and ``lost+found`` system +databases. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-list-databases-response.json + :language: javascript + + + + + + + + + + + + + diff --git a/api-ref/source/datastores.inc b/api-ref/source/datastores.inc new file mode 100644 index 0000000000..e556295962 --- /dev/null +++ b/api-ref/source/datastores.inc @@ -0,0 +1,143 @@ +.. -*- rst -*- + +======================== +Data stores (datastores) +======================== + +Lists data store versions, lists parameters for data stores, and +shows parameter details for a data store version. + + +Show configuration parameter details +==================================== + +.. rest_method:: GET /v1.0/{accountId}/datastores/versions/{datastore_version_id}/parameters/{parameter_name} + +Displays details for a configuration parameter associated with a data store version. + +Details include the type, minimum and maximum values, and whether +you must restart the instance after you change the parameter value. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - parameter_name: parameter_name + - datastore_version_id: datastore_version_id + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-show-parameter-details.json + :language: javascript + + + + + + + + + + + + + + +List datastore versions +======================= + +.. rest_method:: GET /v1.0/{accountId}/datastores/{datastore_name}/versions + +Lists the available versions of a data store. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - datastore_name: datastore_name + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-list-datastore-versions.json + :language: javascript + + + + + + + + + + + + + + +List configuration parameters +============================= + +.. rest_method:: GET /v1.0/{accountId}/datastores/versions/{datastore_version_id}/parameters + +Lists the available configuration parameters for a data store version. + +Parameter information includes the type, minimum and maximum +values, and whether you must restart the instance after you change +a parameter value. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - datastore_version_id: datastore_version_id + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-list-parameters-response.json + :language: javascript + + + + + + + + + + + + + diff --git a/api-ref/source/flavors.inc b/api-ref/source/flavors.inc new file mode 100644 index 0000000000..4127737a2a --- /dev/null +++ b/api-ref/source/flavors.inc @@ -0,0 +1,104 @@ +.. -*- rst -*- + +================= +Flavors (flavors) +================= + +Lists all flavors and shows details for a flavor, by ID. + + +Show flavor details +=================== + +.. rest_method:: GET /v1.0/{accountId}/flavors/{flavorId} + +Shows flavor details with details of the RAM. + +This resource is identical to the flavors found in the OpenStack +Compute API, but without the disk property. + +The ``flavorId`` parameter must be an integer value. If you use a +floating point value for this parameter, this call truncates the +decimal portion and uses the integer portion as the ``flavorId`` +value. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - flavorId: flavorId + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-flavors-by-id-response.json + :language: javascript + + + + + + + + + + + + + + +List flavors +============ + +.. rest_method:: GET /v1.0/{accountId}/flavors + +Lists information for all available flavors. + +This operation lists information for all available flavors. + +This resource is identical to the flavors found in the OpenStack +Nova API, but without the disk property. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-flavors-response.json + :language: javascript + + + + + + + + + + + + + diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst new file mode 100755 index 0000000000..9c382fa329 --- /dev/null +++ b/api-ref/source/index.rst @@ -0,0 +1,16 @@ +:tocdepth: 2 + +=================== + Database API +=================== + +.. rest_expand_all:: + +.. include:: api-versions.inc +.. include:: database-instances.inc +.. include:: database-instance-actions.inc +.. include:: databases.inc +.. include:: user-management.inc +.. include:: flavors.inc +.. include:: datastores.inc +.. include:: configurations.inc diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml new file mode 100755 index 0000000000..96f06265be --- /dev/null +++ b/api-ref/source/parameters.yaml @@ -0,0 +1,286 @@ +# variables in path +accountId: + description: | + The account ID of the owner of the instance. + in: path + required: false + type: string +configId: + description: | + The ID of the configuration group. + in: path + required: false + type: string +databaseName: + description: | + The name for the database. + in: path + required: false + type: string +datastore_name: + description: | + The name of the data store. + in: path + required: false + type: string +datastore_version_id: + description: | + The UUID of the data store version. + in: path + required: false + type: string +flavorId: + description: | + The ID for the flavor. + in: path + required: false + type: string +instanceId: + description: | + The ID for the database instance. + in: path + required: false + type: string +parameter_name: + description: | + The name of the parameter for which to show + details. + in: path + required: false + type: string +# variables in body +characterSet: + description: | + A set of symbols and encodings. Default is + ``utf8``. For information about supported character sets and + collations, see `Character Sets and Collations in MySQL + `_. + in: body + required: false + type: string +collate: + description: | + A set of rules for comparing characters in a + character set. Default is ``utf8_general_ci``. For information + about supported character sets and collations, see `Character Sets + and Collations in MySQL `_. + in: body + required: false + type: string +configuration: + description: | + ID of the configuration group that you want to + attach to the instance. + in: body + required: true + type: string +configuration_1: + description: | + ID of the configuration group to attach to the + instance. + in: body + required: false + type: string +configuration_2: + description: | + To detach a configuration group, set the + configuration parameter to null. + in: body + required: true + type: string +created: + description: | + The date and time when the resource was created. + + The date and time stamp format is `ISO 8601 + `_: + + :: + + CCYY-MM-DDThh:mm:ss±hh:mm + + For example, ``2015-08-27T09:49:58-05:00``. + + The ``±hh:mm`` value, if included, is the time zone as an offset + from UTC. In the previous example, the offset value is ``-05:00``. + in: body + required: true + type: string +databases: + description: | + A ``databases`` object. + in: body + required: false + type: array +datastore: + description: | + Data store assigned to the configuration group. + Required if you did not configure the default data store. + in: body + required: true + type: string +datastore_1: + description: | + Name of the datastore to use when creating the + instance. + in: body + required: false + type: string +datastore_version: + description: | + Name of the datastore version to use when + creating the instance. + in: body + required: false + type: string +description: + description: | + New description of the configuration group. + in: body + required: true + type: string +flavor: + description: | + A ``flavor`` object, which includes the flavor ID + (integer) and flavor relative links. + in: body + required: true + type: object +flavorRef: + description: | + Reference (href), which is the actual URI to a + flavor as it appears in the list flavors response. Rather than + the flavor URI, you can also pass the flavor ID (integer) as the + ``flavorRef`` value. For example, ``1``. + in: body + required: true + type: string +instance: + description: | + An ``instance`` object. + in: body + required: true + type: object +name: + description: | + Name of the configuration group you are creating. + in: body + required: true + type: string +name_1: + description: | + A database name. You cannot use the + ``lost+found``, ``information_schema``, or ``mysql`` database name + to create a database because these names are reserved for system + databases. Valid characters in a database name are - Upper and + lower case letters. - Numbers. - ``@``, ``?``, ``#``, and spaces + except at the beginning or end of the database name. - ``_`` is + allowed anywhere in the database name. You cannot use these + characters in a database name. The maximum length of a database + name is 64 characters. + in: body + required: false + type: string +name_2: + description: | + The user name for the database on instance + creation. + in: body + required: false + type: string +name_3: + description: | + New name of the configuration group. + in: body + required: true + type: string +password: + description: | + The password for those users on instance + creation. + in: body + required: false + type: string +replica_count: + description: | + Number of replicas to create (defaults to 1). + in: body + required: false + type: integer +replica_of: + description: | + ID or name of an existing instance to replicate + from. + in: body + required: false + type: string +replica_of_1: + description: | + To detach a replica, set ``replica_of`` to null. + in: body + required: true + type: string +size: + description: | + The volume size, in gigabytes (GB). A valid value + is from 1 to 50. + in: body + required: true + type: integer +slave_of: + description: | + To detach a replica, set ``slave_of`` to null. + in: body + required: true + type: string +type: + description: | + The volume type to use. You can list the + available volume types on your system by using the ``cinder type- + list`` command. If you want to specify a volume type, you must + also specify a volume size. + in: body + required: false + type: string +updated: + description: | + The date and time when the resource was updated. + + The date and time stamp format is `ISO 8601 + `_: + + :: + + CCYY-MM-DDThh:mm:ss±hh:mm + + The ``±hh:mm`` value, if included, is the time zone as an offset + from UTC. + + For example, ``2015-08-27T09:49:58-05:00``. + + The UTC time zone is assumed. + in: body + required: true + type: string +users: + description: | + A ``users`` object. + in: body + required: true + type: array +values: + description: | + Dictionary that lists configuration parameter + names and associated values. + in: body + required: true + type: string +values_1: + description: | + Dictionary that lists configuration parameter + names and associated values. + in: body + required: true + type: object + diff --git a/api-ref/source/samples/db-attach-config-group-request-json-http.txt b/api-ref/source/samples/db-attach-config-group-request-json-http.txt new file mode 100644 index 0000000000..478e049396 --- /dev/null +++ b/api-ref/source/samples/db-attach-config-group-request-json-http.txt @@ -0,0 +1,7 @@ +PUT /v1.0/1234/instances/4c93c73b-d6d0-47d7-b8c6-b699d19d7de9 HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + diff --git a/api-ref/source/samples/db-attach-config-group-request.json b/api-ref/source/samples/db-attach-config-group-request.json new file mode 100644 index 0000000000..d5708d9103 --- /dev/null +++ b/api-ref/source/samples/db-attach-config-group-request.json @@ -0,0 +1,5 @@ +{ + "instance": { + "configuration": "2aa51628-5c42-4086-8682-137caffd2ba6" + } +} diff --git a/api-ref/source/samples/db-attach-config-group-response-json-http.txt b/api-ref/source/samples/db-attach-config-group-response-json-http.txt new file mode 100644 index 0000000000..c7fabb46fd --- /dev/null +++ b/api-ref/source/samples/db-attach-config-group-response-json-http.txt @@ -0,0 +1,5 @@ +HTTP/1.1 202 OK +Content-Type: application/json +Content-Length: 0 +Date: Mon, 13 Jul 2015 19:53:04 GMT + diff --git a/apidocs/src/samples/db-backup-create-incremental-request-json.txt b/api-ref/source/samples/db-backup-create-incremental-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-backup-create-incremental-request-json.txt rename to api-ref/source/samples/db-backup-create-incremental-request-json-http.txt diff --git a/apidocs/src/samples/db-backup-create-incremental-request.json b/api-ref/source/samples/db-backup-create-incremental-request.json similarity index 99% rename from apidocs/src/samples/db-backup-create-incremental-request.json rename to api-ref/source/samples/db-backup-create-incremental-request.json index 902545c95b..1688c08059 100644 --- a/apidocs/src/samples/db-backup-create-incremental-request.json +++ b/api-ref/source/samples/db-backup-create-incremental-request.json @@ -6,4 +6,3 @@ "parent_id": "a9832168-7541-4536-b8d9-a8a9b79cf1b4" } } - diff --git a/apidocs/src/samples/db-backup-create-incremental-response-json.txt b/api-ref/source/samples/db-backup-create-incremental-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-backup-create-incremental-response-json.txt rename to api-ref/source/samples/db-backup-create-incremental-response-json-http.txt diff --git a/apidocs/src/samples/db-backup-create-incremental-response.json b/api-ref/source/samples/db-backup-create-incremental-response.json similarity index 99% rename from apidocs/src/samples/db-backup-create-incremental-response.json rename to api-ref/source/samples/db-backup-create-incremental-response.json index e70aefcc99..1520e86611 100644 --- a/apidocs/src/samples/db-backup-create-incremental-response.json +++ b/api-ref/source/samples/db-backup-create-incremental-response.json @@ -17,4 +17,3 @@ "updated": "2014-10-30T12:30:00" } } - diff --git a/apidocs/src/samples/db-backup-create-request-json.txt b/api-ref/source/samples/db-backup-create-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-backup-create-request-json.txt rename to api-ref/source/samples/db-backup-create-request-json-http.txt diff --git a/apidocs/src/samples/db-backup-create-request.json b/api-ref/source/samples/db-backup-create-request.json similarity index 99% rename from apidocs/src/samples/db-backup-create-request.json rename to api-ref/source/samples/db-backup-create-request.json index 335d201f9e..004b3a9251 100644 --- a/apidocs/src/samples/db-backup-create-request.json +++ b/api-ref/source/samples/db-backup-create-request.json @@ -5,4 +5,3 @@ "name": "snapshot" } } - diff --git a/apidocs/src/samples/db-backup-create-response-json.txt b/api-ref/source/samples/db-backup-create-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-backup-create-response-json.txt rename to api-ref/source/samples/db-backup-create-response-json-http.txt diff --git a/apidocs/src/samples/db-backup-create-response.json b/api-ref/source/samples/db-backup-create-response.json similarity index 99% rename from apidocs/src/samples/db-backup-create-response.json rename to api-ref/source/samples/db-backup-create-response.json index f6dd1da6ff..fc964dd117 100644 --- a/apidocs/src/samples/db-backup-create-response.json +++ b/api-ref/source/samples/db-backup-create-response.json @@ -17,4 +17,3 @@ "updated": "2014-10-30T12:30:00" } } - diff --git a/apidocs/src/samples/db-backup-delete-request-json.txt b/api-ref/source/samples/db-backup-delete-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-backup-delete-request-json.txt rename to api-ref/source/samples/db-backup-delete-request-json-http.txt diff --git a/apidocs/src/samples/db-backup-delete-response-json.txt b/api-ref/source/samples/db-backup-delete-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-backup-delete-response-json.txt rename to api-ref/source/samples/db-backup-delete-response-json-http.txt diff --git a/apidocs/src/samples/db-backup-get-request-json.txt b/api-ref/source/samples/db-backup-get-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-backup-get-request-json.txt rename to api-ref/source/samples/db-backup-get-request-json-http.txt diff --git a/apidocs/src/samples/db-backup-get-response-json.txt b/api-ref/source/samples/db-backup-get-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-backup-get-response-json.txt rename to api-ref/source/samples/db-backup-get-response-json-http.txt diff --git a/apidocs/src/samples/db-backup-get-response.json b/api-ref/source/samples/db-backup-get-response.json similarity index 99% rename from apidocs/src/samples/db-backup-get-response.json rename to api-ref/source/samples/db-backup-get-response.json index ee7dc1131c..e7f5928550 100644 --- a/apidocs/src/samples/db-backup-get-response.json +++ b/api-ref/source/samples/db-backup-get-response.json @@ -17,4 +17,3 @@ "updated": "2014-10-30T12:30:00" } } - diff --git a/apidocs/src/samples/db-backup-list-request-json.txt b/api-ref/source/samples/db-backup-list-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-backup-list-request-json.txt rename to api-ref/source/samples/db-backup-list-request-json-http.txt diff --git a/apidocs/src/samples/db-backup-list-response-json.txt b/api-ref/source/samples/db-backup-list-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-backup-list-response-json.txt rename to api-ref/source/samples/db-backup-list-response-json-http.txt diff --git a/apidocs/src/samples/db-backup-list-response.json b/api-ref/source/samples/db-backup-list-response.json similarity index 100% rename from apidocs/src/samples/db-backup-list-response.json rename to api-ref/source/samples/db-backup-list-response.json diff --git a/apidocs/src/samples/db-backup-restore-request-json.txt b/api-ref/source/samples/db-backup-restore-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-backup-restore-request-json.txt rename to api-ref/source/samples/db-backup-restore-request-json-http.txt diff --git a/apidocs/src/samples/db-backup-restore-request.json b/api-ref/source/samples/db-backup-restore-request.json similarity index 99% rename from apidocs/src/samples/db-backup-restore-request.json rename to api-ref/source/samples/db-backup-restore-request.json index 3586c522a9..105b90372f 100644 --- a/apidocs/src/samples/db-backup-restore-request.json +++ b/api-ref/source/samples/db-backup-restore-request.json @@ -10,4 +10,3 @@ } } } - diff --git a/apidocs/src/samples/db-backup-restore-response-json.txt b/api-ref/source/samples/db-backup-restore-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-backup-restore-response-json.txt rename to api-ref/source/samples/db-backup-restore-response-json-http.txt diff --git a/apidocs/src/samples/db-backup-restore-response.json b/api-ref/source/samples/db-backup-restore-response.json similarity index 99% rename from apidocs/src/samples/db-backup-restore-response.json rename to api-ref/source/samples/db-backup-restore-response.json index 1d47f46426..005899d157 100644 --- a/apidocs/src/samples/db-backup-restore-response.json +++ b/api-ref/source/samples/db-backup-restore-response.json @@ -38,4 +38,3 @@ } } } - diff --git a/apidocs/src/samples/db-backups-by-instance-request-json.txt b/api-ref/source/samples/db-backups-by-instance-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-backups-by-instance-request-json.txt rename to api-ref/source/samples/db-backups-by-instance-request-json-http.txt diff --git a/apidocs/src/samples/db-backups-by-instance-response-json.txt b/api-ref/source/samples/db-backups-by-instance-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-backups-by-instance-response-json.txt rename to api-ref/source/samples/db-backups-by-instance-response-json-http.txt diff --git a/apidocs/src/samples/db-backups-by-instance-response.json b/api-ref/source/samples/db-backups-by-instance-response.json similarity index 100% rename from apidocs/src/samples/db-backups-by-instance-response.json rename to api-ref/source/samples/db-backups-by-instance-response.json diff --git a/apidocs/src/samples/db-change-user-attributes-request-json.txt b/api-ref/source/samples/db-change-user-attributes-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-change-user-attributes-request-json.txt rename to api-ref/source/samples/db-change-user-attributes-request-json-http.txt diff --git a/apidocs/src/samples/db-change-user-attributes-request.json b/api-ref/source/samples/db-change-user-attributes-request.json similarity index 98% rename from apidocs/src/samples/db-change-user-attributes-request.json rename to api-ref/source/samples/db-change-user-attributes-request.json index 5077a238b2..475100603f 100644 --- a/apidocs/src/samples/db-change-user-attributes-request.json +++ b/api-ref/source/samples/db-change-user-attributes-request.json @@ -4,4 +4,3 @@ "password": "new_password" } } - diff --git a/apidocs/src/samples/db-change-user-attributes-response-json.txt b/api-ref/source/samples/db-change-user-attributes-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-change-user-attributes-response-json.txt rename to api-ref/source/samples/db-change-user-attributes-response-json-http.txt diff --git a/apidocs/src/samples/db-change-users-password-request-json.txt b/api-ref/source/samples/db-change-users-password-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-change-users-password-request-json.txt rename to api-ref/source/samples/db-change-users-password-request-json-http.txt diff --git a/apidocs/src/samples/db-change-users-password-request.json b/api-ref/source/samples/db-change-users-password-request.json similarity index 99% rename from apidocs/src/samples/db-change-users-password-request.json rename to api-ref/source/samples/db-change-users-password-request.json index 800a26fcdd..d03c956829 100644 --- a/apidocs/src/samples/db-change-users-password-request.json +++ b/api-ref/source/samples/db-change-users-password-request.json @@ -9,4 +9,4 @@ "password": "anotherpassword" } ] -} \ No newline at end of file +} diff --git a/apidocs/src/samples/db-change-users-password-response-json.txt b/api-ref/source/samples/db-change-users-password-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-change-users-password-response-json.txt rename to api-ref/source/samples/db-change-users-password-response-json-http.txt diff --git a/apidocs/src/samples/db-check-root-user-request-json.txt b/api-ref/source/samples/db-check-root-user-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-check-root-user-request-json.txt rename to api-ref/source/samples/db-check-root-user-request-json-http.txt diff --git a/apidocs/src/samples/db-check-root-user-response-json.txt b/api-ref/source/samples/db-check-root-user-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-check-root-user-response-json.txt rename to api-ref/source/samples/db-check-root-user-response-json-http.txt diff --git a/apidocs/src/samples/db-check-root-user-response.json b/api-ref/source/samples/db-check-root-user-response.json similarity index 96% rename from apidocs/src/samples/db-check-root-user-response.json rename to api-ref/source/samples/db-check-root-user-response.json index d1ed04700b..f3990b45ab 100644 --- a/apidocs/src/samples/db-check-root-user-response.json +++ b/api-ref/source/samples/db-check-root-user-response.json @@ -1,4 +1,3 @@ { "rootEnabled": true } - diff --git a/api-ref/source/samples/db-config-group-details-request-json-http.txt b/api-ref/source/samples/db-config-group-details-request-json-http.txt new file mode 100644 index 0000000000..8ee791ec8c --- /dev/null +++ b/api-ref/source/samples/db-config-group-details-request-json-http.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/configurations/5678 HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json diff --git a/api-ref/source/samples/db-config-group-details-response-json-http.txt b/api-ref/source/samples/db-config-group-details-response-json-http.txt new file mode 100644 index 0000000000..41f9a3b598 --- /dev/null +++ b/api-ref/source/samples/db-config-group-details-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 138 +Date: Fri, 20 Nov 2015 19:53:04 GMT diff --git a/api-ref/source/samples/db-config-group-details-response.json b/api-ref/source/samples/db-config-group-details-response.json new file mode 100644 index 0000000000..a5ee26b415 --- /dev/null +++ b/api-ref/source/samples/db-config-group-details-response.json @@ -0,0 +1,16 @@ +{ + "configuration": { + "datastore_name": "mysql", + "updated": "2015-11-22T19:07:20", + "values": { + "connect_timeout": 17 + }, + "name": "group1", + "created": "2015-11-20T20:51:24", + "datastore_version_name": "5.6", + "instance_count": 1, + "id": "1c8a4fdd-690c-4e6e-b2e1-148b8d738770", + "datastore_version_id": "b9f97132-467b-4f8e-b12d-947cfc223ac3", + "description": null + } +} diff --git a/api-ref/source/samples/db-config-group-instances-request-json-http.txt b/api-ref/source/samples/db-config-group-instances-request-json-http.txt new file mode 100644 index 0000000000..e4840a5be7 --- /dev/null +++ b/api-ref/source/samples/db-config-group-instances-request-json-http.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/configurations/5678/instances HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json diff --git a/api-ref/source/samples/db-config-group-instances-response-json-http.txt b/api-ref/source/samples/db-config-group-instances-response-json-http.txt new file mode 100644 index 0000000000..41f9a3b598 --- /dev/null +++ b/api-ref/source/samples/db-config-group-instances-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 138 +Date: Fri, 20 Nov 2015 19:53:04 GMT diff --git a/api-ref/source/samples/db-config-group-instances-response.json b/api-ref/source/samples/db-config-group-instances-response.json new file mode 100644 index 0000000000..b25b471d32 --- /dev/null +++ b/api-ref/source/samples/db-config-group-instances-response.json @@ -0,0 +1,8 @@ +{ + "instances": [ + { + "id": "7fd2d1d6-a2ef-4a76-8c03-e233db4d86da", + "name": "master_1" + } + ] +} diff --git a/apidocs/src/samples/db-configuration-attach-to-instance-request-json.txt b/api-ref/source/samples/db-configuration-attach-to-instance-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-attach-to-instance-request-json.txt rename to api-ref/source/samples/db-configuration-attach-to-instance-request-json-http.txt diff --git a/apidocs/src/samples/db-configuration-attach-to-instance-request.json b/api-ref/source/samples/db-configuration-attach-to-instance-request.json similarity index 98% rename from apidocs/src/samples/db-configuration-attach-to-instance-request.json rename to api-ref/source/samples/db-configuration-attach-to-instance-request.json index ac4a15c652..633cbfd5a7 100644 --- a/apidocs/src/samples/db-configuration-attach-to-instance-request.json +++ b/api-ref/source/samples/db-configuration-attach-to-instance-request.json @@ -3,4 +3,3 @@ "configuration": "43a6ea86-e959-4735-9e46-a6a5d4a2d80f" } } - diff --git a/apidocs/src/samples/db-configuration-attach-to-instance-response-json.txt b/api-ref/source/samples/db-configuration-attach-to-instance-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-attach-to-instance-response-json.txt rename to api-ref/source/samples/db-configuration-attach-to-instance-response-json-http.txt diff --git a/apidocs/src/samples/db-configuration-create-request-json.txt b/api-ref/source/samples/db-configuration-create-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-create-request-json.txt rename to api-ref/source/samples/db-configuration-create-request-json-http.txt diff --git a/apidocs/src/samples/db-configuration-create-request.json b/api-ref/source/samples/db-configuration-create-request.json similarity index 99% rename from apidocs/src/samples/db-configuration-create-request.json rename to api-ref/source/samples/db-configuration-create-request.json index d66eb1b367..43ae748def 100644 --- a/apidocs/src/samples/db-configuration-create-request.json +++ b/api-ref/source/samples/db-configuration-create-request.json @@ -12,4 +12,3 @@ } } } - diff --git a/apidocs/src/samples/db-configuration-create-response-json.txt b/api-ref/source/samples/db-configuration-create-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-create-response-json.txt rename to api-ref/source/samples/db-configuration-create-response-json-http.txt diff --git a/apidocs/src/samples/db-configuration-create-response.json b/api-ref/source/samples/db-configuration-create-response.json similarity index 99% rename from apidocs/src/samples/db-configuration-create-response.json rename to api-ref/source/samples/db-configuration-create-response.json index 06cc7b1475..a63cd23187 100644 --- a/apidocs/src/samples/db-configuration-create-response.json +++ b/api-ref/source/samples/db-configuration-create-response.json @@ -15,4 +15,3 @@ } } } - diff --git a/apidocs/src/samples/db-configuration-delete-request-json.txt b/api-ref/source/samples/db-configuration-delete-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-delete-request-json.txt rename to api-ref/source/samples/db-configuration-delete-request-json-http.txt diff --git a/apidocs/src/samples/db-configuration-delete-response-json.txt b/api-ref/source/samples/db-configuration-delete-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-delete-response-json.txt rename to api-ref/source/samples/db-configuration-delete-response-json-http.txt diff --git a/apidocs/src/samples/db-configuration-detach-from-instance-request-json.txt b/api-ref/source/samples/db-configuration-detach-from-instance-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-detach-from-instance-request-json.txt rename to api-ref/source/samples/db-configuration-detach-from-instance-request-json-http.txt diff --git a/apidocs/src/samples/db-configuration-detach-from-instance-request.json b/api-ref/source/samples/db-configuration-detach-from-instance-request.json similarity index 98% rename from apidocs/src/samples/db-configuration-detach-from-instance-request.json rename to api-ref/source/samples/db-configuration-detach-from-instance-request.json index e4a08cdc82..587075fc67 100644 --- a/apidocs/src/samples/db-configuration-detach-from-instance-request.json +++ b/api-ref/source/samples/db-configuration-detach-from-instance-request.json @@ -3,4 +3,3 @@ "configuration": "" } } - diff --git a/apidocs/src/samples/db-configuration-detach-from-instance-response-json.txt b/api-ref/source/samples/db-configuration-detach-from-instance-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-detach-from-instance-response-json.txt rename to api-ref/source/samples/db-configuration-detach-from-instance-response-json-http.txt diff --git a/apidocs/src/samples/db-configuration-details-request-json.txt b/api-ref/source/samples/db-configuration-details-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-details-request-json.txt rename to api-ref/source/samples/db-configuration-details-request-json-http.txt diff --git a/apidocs/src/samples/db-configuration-details-response-json.txt b/api-ref/source/samples/db-configuration-details-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-details-response-json.txt rename to api-ref/source/samples/db-configuration-details-response-json-http.txt diff --git a/apidocs/src/samples/db-configuration-details-response.json b/api-ref/source/samples/db-configuration-details-response.json similarity index 99% rename from apidocs/src/samples/db-configuration-details-response.json rename to api-ref/source/samples/db-configuration-details-response.json index 06cc7b1475..a63cd23187 100644 --- a/apidocs/src/samples/db-configuration-details-response.json +++ b/api-ref/source/samples/db-configuration-details-response.json @@ -15,4 +15,3 @@ } } } - diff --git a/apidocs/src/samples/db-configuration-edit-parameters-request-json.txt b/api-ref/source/samples/db-configuration-edit-parameters-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-edit-parameters-request-json.txt rename to api-ref/source/samples/db-configuration-edit-parameters-request-json-http.txt diff --git a/apidocs/src/samples/db-configuration-edit-parameters-request.json b/api-ref/source/samples/db-configuration-edit-parameters-request.json similarity index 98% rename from apidocs/src/samples/db-configuration-edit-parameters-request.json rename to api-ref/source/samples/db-configuration-edit-parameters-request.json index b798a508d0..026cdc0aee 100644 --- a/apidocs/src/samples/db-configuration-edit-parameters-request.json +++ b/api-ref/source/samples/db-configuration-edit-parameters-request.json @@ -5,4 +5,3 @@ } } } - diff --git a/apidocs/src/samples/db-configuration-edit-parameters-response-json.txt b/api-ref/source/samples/db-configuration-edit-parameters-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-edit-parameters-response-json.txt rename to api-ref/source/samples/db-configuration-edit-parameters-response-json-http.txt diff --git a/apidocs/src/samples/db-configuration-list-instances-request-json.txt b/api-ref/source/samples/db-configuration-list-instances-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-list-instances-request-json.txt rename to api-ref/source/samples/db-configuration-list-instances-request-json-http.txt diff --git a/apidocs/src/samples/db-configuration-list-instances-response-json.txt b/api-ref/source/samples/db-configuration-list-instances-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-list-instances-response-json.txt rename to api-ref/source/samples/db-configuration-list-instances-response-json-http.txt diff --git a/apidocs/src/samples/db-configuration-list-instances-response.json b/api-ref/source/samples/db-configuration-list-instances-response.json similarity index 99% rename from apidocs/src/samples/db-configuration-list-instances-response.json rename to api-ref/source/samples/db-configuration-list-instances-response.json index 6c61262845..69ca083a77 100644 --- a/apidocs/src/samples/db-configuration-list-instances-response.json +++ b/api-ref/source/samples/db-configuration-list-instances-response.json @@ -6,4 +6,3 @@ } ] } - diff --git a/apidocs/src/samples/db-configuration-list-request-json.txt b/api-ref/source/samples/db-configuration-list-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-list-request-json.txt rename to api-ref/source/samples/db-configuration-list-request-json-http.txt diff --git a/apidocs/src/samples/db-configuration-list-response-json.txt b/api-ref/source/samples/db-configuration-list-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-list-response-json.txt rename to api-ref/source/samples/db-configuration-list-response-json-http.txt diff --git a/apidocs/src/samples/db-configuration-list-response.json b/api-ref/source/samples/db-configuration-list-response.json similarity index 99% rename from apidocs/src/samples/db-configuration-list-response.json rename to api-ref/source/samples/db-configuration-list-response.json index 5b0e147c78..d1ece42b0a 100644 --- a/apidocs/src/samples/db-configuration-list-response.json +++ b/api-ref/source/samples/db-configuration-list-response.json @@ -12,4 +12,3 @@ } ] } - diff --git a/apidocs/src/samples/db-configuration-parameter-for-datastore-version-request-json.txt b/api-ref/source/samples/db-configuration-parameter-for-datastore-version-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-parameter-for-datastore-version-request-json.txt rename to api-ref/source/samples/db-configuration-parameter-for-datastore-version-request-json-http.txt diff --git a/apidocs/src/samples/db-configuration-parameter-for-datastore-version-response-json.txt b/api-ref/source/samples/db-configuration-parameter-for-datastore-version-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-parameter-for-datastore-version-response-json.txt rename to api-ref/source/samples/db-configuration-parameter-for-datastore-version-response-json-http.txt diff --git a/apidocs/src/samples/db-configuration-parameter-for-datastore-version-response.json b/api-ref/source/samples/db-configuration-parameter-for-datastore-version-response.json similarity index 100% rename from apidocs/src/samples/db-configuration-parameter-for-datastore-version-response.json rename to api-ref/source/samples/db-configuration-parameter-for-datastore-version-response.json diff --git a/apidocs/src/samples/db-configuration-parameter-without-datastore-version-request-json.txt b/api-ref/source/samples/db-configuration-parameter-without-datastore-version-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-parameter-without-datastore-version-request-json.txt rename to api-ref/source/samples/db-configuration-parameter-without-datastore-version-request-json-http.txt diff --git a/apidocs/src/samples/db-configuration-parameter-without-datastore-version-response-json.txt b/api-ref/source/samples/db-configuration-parameter-without-datastore-version-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-parameter-without-datastore-version-response-json.txt rename to api-ref/source/samples/db-configuration-parameter-without-datastore-version-response-json-http.txt diff --git a/apidocs/src/samples/db-configuration-parameter-without-datastore-version-response.json b/api-ref/source/samples/db-configuration-parameter-without-datastore-version-response.json similarity index 100% rename from apidocs/src/samples/db-configuration-parameter-without-datastore-version-response.json rename to api-ref/source/samples/db-configuration-parameter-without-datastore-version-response.json diff --git a/apidocs/src/samples/db-configuration-parameters-for-datastore-version-request-json.txt b/api-ref/source/samples/db-configuration-parameters-for-datastore-version-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-parameters-for-datastore-version-request-json.txt rename to api-ref/source/samples/db-configuration-parameters-for-datastore-version-request-json-http.txt diff --git a/apidocs/src/samples/db-configuration-parameters-for-datastore-version-response-json.txt b/api-ref/source/samples/db-configuration-parameters-for-datastore-version-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-parameters-for-datastore-version-response-json.txt rename to api-ref/source/samples/db-configuration-parameters-for-datastore-version-response-json-http.txt diff --git a/apidocs/src/samples/db-configuration-parameters-for-datastore-version-response.json b/api-ref/source/samples/db-configuration-parameters-for-datastore-version-response.json similarity index 100% rename from apidocs/src/samples/db-configuration-parameters-for-datastore-version-response.json rename to api-ref/source/samples/db-configuration-parameters-for-datastore-version-response.json diff --git a/apidocs/src/samples/db-configuration-parameters-without-datastore-version-request-json.txt b/api-ref/source/samples/db-configuration-parameters-without-datastore-version-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-parameters-without-datastore-version-request-json.txt rename to api-ref/source/samples/db-configuration-parameters-without-datastore-version-request-json-http.txt diff --git a/apidocs/src/samples/db-configuration-parameters-without-datastore-version-response-json.txt b/api-ref/source/samples/db-configuration-parameters-without-datastore-version-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-parameters-without-datastore-version-response-json.txt rename to api-ref/source/samples/db-configuration-parameters-without-datastore-version-response-json-http.txt diff --git a/apidocs/src/samples/db-configuration-parameters-without-datastore-version-response.json b/api-ref/source/samples/db-configuration-parameters-without-datastore-version-response.json similarity index 100% rename from apidocs/src/samples/db-configuration-parameters-without-datastore-version-response.json rename to api-ref/source/samples/db-configuration-parameters-without-datastore-version-response.json diff --git a/apidocs/src/samples/db-configuration-update-parameters-request-json.txt b/api-ref/source/samples/db-configuration-update-parameters-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-update-parameters-request-json.txt rename to api-ref/source/samples/db-configuration-update-parameters-request-json-http.txt diff --git a/apidocs/src/samples/db-configuration-update-parameters-request.json b/api-ref/source/samples/db-configuration-update-parameters-request.json similarity index 99% rename from apidocs/src/samples/db-configuration-update-parameters-request.json rename to api-ref/source/samples/db-configuration-update-parameters-request.json index 78548d925b..08a51cdd91 100644 --- a/apidocs/src/samples/db-configuration-update-parameters-request.json +++ b/api-ref/source/samples/db-configuration-update-parameters-request.json @@ -8,4 +8,3 @@ } } } - diff --git a/apidocs/src/samples/db-configuration-update-parameters-response-json.txt b/api-ref/source/samples/db-configuration-update-parameters-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-configuration-update-parameters-response-json.txt rename to api-ref/source/samples/db-configuration-update-parameters-response-json-http.txt diff --git a/api-ref/source/samples/db-create-config-group-request-json-http.txt b/api-ref/source/samples/db-create-config-group-request-json-http.txt new file mode 100644 index 0000000000..a346a2d633 --- /dev/null +++ b/api-ref/source/samples/db-create-config-group-request-json-http.txt @@ -0,0 +1,7 @@ +POST /v1.0/1234/configurations HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: d6cafa5b-e0c7-4ab8-948e-7c95f2acd031 +Accept: application/json +Content-Type: application/json + diff --git a/api-ref/source/samples/db-create-config-group-request.json b/api-ref/source/samples/db-create-config-group-request.json new file mode 100644 index 0000000000..e8acd72a6e --- /dev/null +++ b/api-ref/source/samples/db-create-config-group-request.json @@ -0,0 +1,15 @@ +{ + "configuration": { + "datastore": [ + { + "type": "mysql" + } + ], + "values": [ + { + "sync_binlog": 1 + } + ], + "name": "group1" + } +} diff --git a/api-ref/source/samples/db-create-config-group-response-json-http.txt b/api-ref/source/samples/db-create-config-group-response-json-http.txt new file mode 100644 index 0000000000..4033d89826 --- /dev/null +++ b/api-ref/source/samples/db-create-config-group-response-json-http.txt @@ -0,0 +1,5 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 360 +Date: Mon, 6 Jul 2015 21:53:10 GMT + diff --git a/api-ref/source/samples/db-create-config-group-response.json b/api-ref/source/samples/db-create-config-group-response.json new file mode 100644 index 0000000000..7a2c4fe68d --- /dev/null +++ b/api-ref/source/samples/db-create-config-group-response.json @@ -0,0 +1,14 @@ +{ + "updated": "2015-07-01T16:38:27", + "name": "group1", + "created": "2015-07-01T16:38:27", + "instance_count": 0, + "values": { + "sync_binlog": 1 + }, + "datastore_version_id": "2dc7faa0-efff-4c2b-8cff-bcd949c518a5", + "id": "2aa51628-5c42-4086-8682-137caffd2ba6", + "datastore_name": "mysql", + "datastore_version_name": "5.6", + "description": null +} diff --git a/apidocs/src/samples/db-create-databases-request-json.txt b/api-ref/source/samples/db-create-databases-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-create-databases-request-json.txt rename to api-ref/source/samples/db-create-databases-request-json-http.txt diff --git a/apidocs/src/samples/db-create-databases-request.json b/api-ref/source/samples/db-create-databases-request.json similarity index 99% rename from apidocs/src/samples/db-create-databases-request.json rename to api-ref/source/samples/db-create-databases-request.json index 486558f46e..92ea30ceb0 100644 --- a/apidocs/src/samples/db-create-databases-request.json +++ b/api-ref/source/samples/db-create-databases-request.json @@ -13,4 +13,3 @@ } ] } - diff --git a/apidocs/src/samples/db-create-databases-response-json.txt b/api-ref/source/samples/db-create-databases-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-create-databases-response-json.txt rename to api-ref/source/samples/db-create-databases-response-json-http.txt diff --git a/apidocs/src/samples/db-create-instance-request-json.txt b/api-ref/source/samples/db-create-instance-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-create-instance-request-json.txt rename to api-ref/source/samples/db-create-instance-request-json-http.txt diff --git a/apidocs/src/samples/db-create-instance-request.json b/api-ref/source/samples/db-create-instance-request.json similarity index 99% rename from apidocs/src/samples/db-create-instance-request.json rename to api-ref/source/samples/db-create-instance-request.json index 1773a5f428..e22b97c5e5 100644 --- a/apidocs/src/samples/db-create-instance-request.json +++ b/api-ref/source/samples/db-create-instance-request.json @@ -28,4 +28,3 @@ } } } - diff --git a/apidocs/src/samples/db-create-instance-response-json.txt b/api-ref/source/samples/db-create-instance-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-create-instance-response-json.txt rename to api-ref/source/samples/db-create-instance-response-json-http.txt diff --git a/apidocs/src/samples/db-create-instance-response.json b/api-ref/source/samples/db-create-instance-response.json similarity index 99% rename from apidocs/src/samples/db-create-instance-response.json rename to api-ref/source/samples/db-create-instance-response.json index f73dd34e61..a1bf8e9a4e 100644 --- a/apidocs/src/samples/db-create-instance-response.json +++ b/api-ref/source/samples/db-create-instance-response.json @@ -38,4 +38,3 @@ } } } - diff --git a/apidocs/src/samples/db-create-users-request-json.txt b/api-ref/source/samples/db-create-users-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-create-users-request-json.txt rename to api-ref/source/samples/db-create-users-request-json-http.txt diff --git a/apidocs/src/samples/db-create-users-request.json b/api-ref/source/samples/db-create-users-request.json similarity index 99% rename from apidocs/src/samples/db-create-users-request.json rename to api-ref/source/samples/db-create-users-request.json index 78d1a2ae2d..c737d3909b 100644 --- a/apidocs/src/samples/db-create-users-request.json +++ b/api-ref/source/samples/db-create-users-request.json @@ -32,4 +32,3 @@ } ] } - diff --git a/apidocs/src/samples/db-create-users-response-json.txt b/api-ref/source/samples/db-create-users-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-create-users-response-json.txt rename to api-ref/source/samples/db-create-users-response-json-http.txt diff --git a/apidocs/src/samples/db-datastore-by-id-request-json.txt b/api-ref/source/samples/db-datastore-by-id-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-datastore-by-id-request-json.txt rename to api-ref/source/samples/db-datastore-by-id-request-json-http.txt diff --git a/apidocs/src/samples/db-datastore-by-id-response-json.txt b/api-ref/source/samples/db-datastore-by-id-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-datastore-by-id-response-json.txt rename to api-ref/source/samples/db-datastore-by-id-response-json-http.txt diff --git a/apidocs/src/samples/db-datastore-by-id-response.json b/api-ref/source/samples/db-datastore-by-id-response.json similarity index 99% rename from apidocs/src/samples/db-datastore-by-id-response.json rename to api-ref/source/samples/db-datastore-by-id-response.json index e5cb3bd084..fb69c160ea 100644 --- a/apidocs/src/samples/db-datastore-by-id-response.json +++ b/api-ref/source/samples/db-datastore-by-id-response.json @@ -31,4 +31,3 @@ ] } } - diff --git a/api-ref/source/samples/db-datastore-parameters-response.json b/api-ref/source/samples/db-datastore-parameters-response.json new file mode 100644 index 0000000000..7f9153c8a2 --- /dev/null +++ b/api-ref/source/samples/db-datastore-parameters-response.json @@ -0,0 +1,258 @@ +{ + "configuration-parameters": [ + { + "name": "myisam_sort_buffer_size", + "min": 4096, + "max": 18446744073709552000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "sync_binlog", + "min": 0, + "max": 4294967295, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "max_allowed_packet", + "min": 1024, + "max": 1073741824, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "type": "string", + "name": "character_set_connection", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "name": "autocommit", + "min": 0, + "max": 1, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "type": "string", + "name": "character_set_client", + "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "name": "join_buffer_size", + "min": 128, + "max": 18446744073709548000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "local_infile", + "min": 0, + "max": 1, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "auto_increment_offset", + "min": 1, + "max": 65535, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "max_connections", + "min": 1, + "max": 100000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "bulk_insert_buffer_size", + "min": 0, + "max": 18446744073709552000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef474dac18-2c6abd35a758" + }, + { + "name": "sort_buffer_size", + "min": 32768, + "max": 18446744073709552000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "innodb_log_buffer_size", + "min": 262144, + "max": 4294967295, + "restart_required": true, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "innodb_file_per_table", + "min": 0, + "max": 1, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "type": "string", + "name": "character_set_server", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "name": "innodb_buffer_pool_size", + "min": 5242880, + "max": 18446744073709552000, + "restart_required": true, + "type": "integer", + "datastore_version_id": "f597f709-70ef474dac18-2c6abd35a758" + }, + { + "type": "string", + "name": "collation_server", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "type": "string", + "name": "character_set_filesystem", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "type": "string", + "name": "collation_database", + "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "name": "innodb_flush_log_at_trx_commit", + "min": 0, + "max": 2, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "interactive_timeout", + "min": 1, + "max": 65535, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "max_user_connections", + "min": 0, + "max": 4294967295, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "innodb_thread_concurrency", + "min": 0, + "max": 1000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "innodb_open_files", + "min": 10, + "max": 4294967295, + "restart_required": true, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "key_buffer_size", + "min": 8, + "max": 4294967295, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758" + }, + { + "name": "connect_timeout", + "min": 2, + "max": 31536000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758" + }, + { + "type": "string", + "name": "collation_connection", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "type": "string", + "name": "character_set_database", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "name": "auto_increment_increment", + "min": 1, + "max": 65535, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "max_connect_errors", + "min": 1, + "max": 18446744073709552000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "type": "string", + "name": "character_set_results", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "name": "expire_logs_days", + "min": 0, + "max": 99, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "wait_timeout", + "min": 1, + "max": 31536000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758" + }, + { + "name": "server_id", + "min": 0, + "max": 4294967295, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + } + ] +} diff --git a/apidocs/src/samples/db-datastore-version-by-id-request-json.txt b/api-ref/source/samples/db-datastore-version-by-id-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-datastore-version-by-id-request-json.txt rename to api-ref/source/samples/db-datastore-version-by-id-request-json-http.txt diff --git a/apidocs/src/samples/db-datastore-version-by-id-response-json.txt b/api-ref/source/samples/db-datastore-version-by-id-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-datastore-version-by-id-response-json.txt rename to api-ref/source/samples/db-datastore-version-by-id-response-json-http.txt diff --git a/apidocs/src/samples/db-datastore-version-by-id-response.json b/api-ref/source/samples/db-datastore-version-by-id-response.json similarity index 99% rename from apidocs/src/samples/db-datastore-version-by-id-response.json rename to api-ref/source/samples/db-datastore-version-by-id-response.json index ae61965454..109204a84e 100644 --- a/apidocs/src/samples/db-datastore-version-by-id-response.json +++ b/api-ref/source/samples/db-datastore-version-by-id-response.json @@ -15,4 +15,3 @@ "name": "5.5" } } - diff --git a/apidocs/src/samples/db-datastore-versions-list-request-json.txt b/api-ref/source/samples/db-datastore-versions-list-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-datastore-versions-list-request-json.txt rename to api-ref/source/samples/db-datastore-versions-list-request-json-http.txt diff --git a/apidocs/src/samples/db-datastore-versions-list-response-json.txt b/api-ref/source/samples/db-datastore-versions-list-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-datastore-versions-list-response-json.txt rename to api-ref/source/samples/db-datastore-versions-list-response-json-http.txt diff --git a/apidocs/src/samples/db-datastore-versions-list-response.json b/api-ref/source/samples/db-datastore-versions-list-response.json similarity index 99% rename from apidocs/src/samples/db-datastore-versions-list-response.json rename to api-ref/source/samples/db-datastore-versions-list-response.json index fb8c8e1235..a29e841227 100644 --- a/apidocs/src/samples/db-datastore-versions-list-response.json +++ b/api-ref/source/samples/db-datastore-versions-list-response.json @@ -17,4 +17,3 @@ } ] } - diff --git a/apidocs/src/samples/db-datastores-list-request-json.txt b/api-ref/source/samples/db-datastores-list-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-datastores-list-request-json.txt rename to api-ref/source/samples/db-datastores-list-request-json-http.txt diff --git a/apidocs/src/samples/db-datastores-list-response-json.txt b/api-ref/source/samples/db-datastores-list-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-datastores-list-response-json.txt rename to api-ref/source/samples/db-datastores-list-response-json-http.txt diff --git a/apidocs/src/samples/db-datastores-list-response.json b/api-ref/source/samples/db-datastores-list-response.json similarity index 99% rename from apidocs/src/samples/db-datastores-list-response.json rename to api-ref/source/samples/db-datastores-list-response.json index 29b4746233..58da3cbd19 100644 --- a/apidocs/src/samples/db-datastores-list-response.json +++ b/api-ref/source/samples/db-datastores-list-response.json @@ -33,4 +33,3 @@ } ] } - diff --git a/api-ref/source/samples/db-delete-config-group-request-json-http.txt b/api-ref/source/samples/db-delete-config-group-request-json-http.txt new file mode 100644 index 0000000000..a4d2f0cfda --- /dev/null +++ b/api-ref/source/samples/db-delete-config-group-request-json-http.txt @@ -0,0 +1,6 @@ +DELETE /v1.0/1234/configurations/692d8418-7a8f-47f1-8060-59846c6e024f HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json diff --git a/apidocs/src/samples/db-delete-databases-request-json.txt b/api-ref/source/samples/db-delete-databases-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-delete-databases-request-json.txt rename to api-ref/source/samples/db-delete-databases-request-json-http.txt diff --git a/apidocs/src/samples/db-delete-databases-response-json.txt b/api-ref/source/samples/db-delete-databases-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-delete-databases-response-json.txt rename to api-ref/source/samples/db-delete-databases-response-json-http.txt diff --git a/apidocs/src/samples/db-delete-instance-request-json.txt b/api-ref/source/samples/db-delete-instance-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-delete-instance-request-json.txt rename to api-ref/source/samples/db-delete-instance-request-json-http.txt diff --git a/apidocs/src/samples/db-delete-instance-response-json.txt b/api-ref/source/samples/db-delete-instance-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-delete-instance-response-json.txt rename to api-ref/source/samples/db-delete-instance-response-json-http.txt diff --git a/api-ref/source/samples/db-delete-root-request-json-http.txt b/api-ref/source/samples/db-delete-root-request-json-http.txt new file mode 100644 index 0000000000..ab9ce8e2fb --- /dev/null +++ b/api-ref/source/samples/db-delete-root-request-json-http.txt @@ -0,0 +1,7 @@ +DELETE /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/root HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + diff --git a/apidocs/src/samples/db-delete-users-request-json.txt b/api-ref/source/samples/db-delete-users-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-delete-users-request-json.txt rename to api-ref/source/samples/db-delete-users-request-json-http.txt diff --git a/apidocs/src/samples/db-delete-users-response-json.txt b/api-ref/source/samples/db-delete-users-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-delete-users-response-json.txt rename to api-ref/source/samples/db-delete-users-response-json-http.txt diff --git a/api-ref/source/samples/db-detach-config-group-request-json-http.txt b/api-ref/source/samples/db-detach-config-group-request-json-http.txt new file mode 100644 index 0000000000..478e049396 --- /dev/null +++ b/api-ref/source/samples/db-detach-config-group-request-json-http.txt @@ -0,0 +1,7 @@ +PUT /v1.0/1234/instances/4c93c73b-d6d0-47d7-b8c6-b699d19d7de9 HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + diff --git a/api-ref/source/samples/db-detach-config-group-request.json b/api-ref/source/samples/db-detach-config-group-request.json new file mode 100644 index 0000000000..24b79afa21 --- /dev/null +++ b/api-ref/source/samples/db-detach-config-group-request.json @@ -0,0 +1,3 @@ +{ + "instance": {} +} diff --git a/api-ref/source/samples/db-detach-config-group-response-json-http.txt b/api-ref/source/samples/db-detach-config-group-response-json-http.txt new file mode 100644 index 0000000000..c7fabb46fd --- /dev/null +++ b/api-ref/source/samples/db-detach-config-group-response-json-http.txt @@ -0,0 +1,5 @@ +HTTP/1.1 202 OK +Content-Type: application/json +Content-Length: 0 +Date: Mon, 13 Jul 2015 19:53:04 GMT + diff --git a/api-ref/source/samples/db-detach-replica-request-json-http.txt b/api-ref/source/samples/db-detach-replica-request-json-http.txt new file mode 100644 index 0000000000..cea1a9078b --- /dev/null +++ b/api-ref/source/samples/db-detach-replica-request-json-http.txt @@ -0,0 +1,7 @@ +PATCH /v1.0/1234/instances/4c93c73b-d6d0-47d7-b8c6-b699d19d7de9 HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + diff --git a/api-ref/source/samples/db-detach-replica-request.json b/api-ref/source/samples/db-detach-replica-request.json new file mode 100644 index 0000000000..f61219c8a1 --- /dev/null +++ b/api-ref/source/samples/db-detach-replica-request.json @@ -0,0 +1,6 @@ +{ + "instance": { + "replica_of": null, + "slave_of": null + } +} diff --git a/api-ref/source/samples/db-detach-replica-response-json-http.txt b/api-ref/source/samples/db-detach-replica-response-json-http.txt new file mode 100644 index 0000000000..c7fabb46fd --- /dev/null +++ b/api-ref/source/samples/db-detach-replica-response-json-http.txt @@ -0,0 +1,5 @@ +HTTP/1.1 202 OK +Content-Type: application/json +Content-Length: 0 +Date: Mon, 13 Jul 2015 19:53:04 GMT + diff --git a/apidocs/src/samples/db-disable-root-user-request-json.txt b/api-ref/source/samples/db-disable-root-user-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-disable-root-user-request-json.txt rename to api-ref/source/samples/db-disable-root-user-request-json-http.txt diff --git a/apidocs/src/samples/db-disable-root-user-response-json.txt b/api-ref/source/samples/db-disable-root-user-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-disable-root-user-response-json.txt rename to api-ref/source/samples/db-disable-root-user-response-json-http.txt diff --git a/apidocs/src/samples/db-enable-root-user-request-json.txt b/api-ref/source/samples/db-enable-root-user-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-enable-root-user-request-json.txt rename to api-ref/source/samples/db-enable-root-user-request-json-http.txt diff --git a/apidocs/src/samples/db-enable-root-user-response-json.txt b/api-ref/source/samples/db-enable-root-user-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-enable-root-user-response-json.txt rename to api-ref/source/samples/db-enable-root-user-response-json-http.txt diff --git a/apidocs/src/samples/db-enable-root-user-response.json b/api-ref/source/samples/db-enable-root-user-response.json similarity index 98% rename from apidocs/src/samples/db-enable-root-user-response.json rename to api-ref/source/samples/db-enable-root-user-response.json index a8e0a9bed9..4be60a595e 100644 --- a/apidocs/src/samples/db-enable-root-user-response.json +++ b/api-ref/source/samples/db-enable-root-user-response.json @@ -4,4 +4,3 @@ "password": "12345" } } - diff --git a/apidocs/src/samples/db-faults-badRequest.json b/api-ref/source/samples/db-faults-badRequest.json similarity index 98% rename from apidocs/src/samples/db-faults-badRequest.json rename to api-ref/source/samples/db-faults-badRequest.json index 349ca55e52..2b04f07d3c 100644 --- a/apidocs/src/samples/db-faults-badRequest.json +++ b/api-ref/source/samples/db-faults-badRequest.json @@ -3,4 +3,4 @@ "code": 400, "message": "Volume 'size' needs to be a positive integer value, -1.0 cannot be accepted." } -} \ No newline at end of file +} diff --git a/apidocs/src/samples/db-faults-instanceFault.json b/api-ref/source/samples/db-faults-instanceFault.json similarity index 98% rename from apidocs/src/samples/db-faults-instanceFault.json rename to api-ref/source/samples/db-faults-instanceFault.json index 911d66735b..e9b42d5ce0 100644 --- a/apidocs/src/samples/db-faults-instanceFault.json +++ b/api-ref/source/samples/db-faults-instanceFault.json @@ -3,4 +3,4 @@ "code": 500, "message": "The server has either erred or is incapable of performing the requested operation." } -} \ No newline at end of file +} diff --git a/apidocs/src/samples/db-faults-itemNotFound.json b/api-ref/source/samples/db-faults-itemNotFound.json similarity index 98% rename from apidocs/src/samples/db-faults-itemNotFound.json rename to api-ref/source/samples/db-faults-itemNotFound.json index c1198b7dd1..6c7318392f 100644 --- a/apidocs/src/samples/db-faults-itemNotFound.json +++ b/api-ref/source/samples/db-faults-itemNotFound.json @@ -3,4 +3,4 @@ "code": 404, "message": "The resource could not be found." } -} \ No newline at end of file +} diff --git a/apidocs/src/samples/db-flavors-by-id-request-json.txt b/api-ref/source/samples/db-flavors-by-id-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-flavors-by-id-request-json.txt rename to api-ref/source/samples/db-flavors-by-id-request-json-http.txt diff --git a/apidocs/src/samples/db-flavors-by-id-response-json.txt b/api-ref/source/samples/db-flavors-by-id-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-flavors-by-id-response-json.txt rename to api-ref/source/samples/db-flavors-by-id-response-json-http.txt diff --git a/apidocs/src/samples/db-flavors-by-id-response.json b/api-ref/source/samples/db-flavors-by-id-response.json similarity index 100% rename from apidocs/src/samples/db-flavors-by-id-response.json rename to api-ref/source/samples/db-flavors-by-id-response.json diff --git a/apidocs/src/samples/db-flavors-request-json.txt b/api-ref/source/samples/db-flavors-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-flavors-request-json.txt rename to api-ref/source/samples/db-flavors-request-json-http.txt diff --git a/apidocs/src/samples/db-flavors-response-json.txt b/api-ref/source/samples/db-flavors-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-flavors-response-json.txt rename to api-ref/source/samples/db-flavors-response-json-http.txt diff --git a/apidocs/src/samples/db-flavors-response.json b/api-ref/source/samples/db-flavors-response.json similarity index 100% rename from apidocs/src/samples/db-flavors-response.json rename to api-ref/source/samples/db-flavors-response.json diff --git a/apidocs/src/samples/db-get-default-instance-configuration-request-json.txt b/api-ref/source/samples/db-get-default-instance-configuration-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-get-default-instance-configuration-request-json.txt rename to api-ref/source/samples/db-get-default-instance-configuration-request-json-http.txt diff --git a/apidocs/src/samples/db-get-default-instance-configuration-response-json.txt b/api-ref/source/samples/db-get-default-instance-configuration-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-get-default-instance-configuration-response-json.txt rename to api-ref/source/samples/db-get-default-instance-configuration-response-json-http.txt diff --git a/apidocs/src/samples/db-get-default-instance-configuration-response.json b/api-ref/source/samples/db-get-default-instance-configuration-response.json similarity index 100% rename from apidocs/src/samples/db-get-default-instance-configuration-response.json rename to api-ref/source/samples/db-get-default-instance-configuration-response.json diff --git a/apidocs/src/samples/db-grant-user-access-request-json.txt b/api-ref/source/samples/db-grant-user-access-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-grant-user-access-request-json.txt rename to api-ref/source/samples/db-grant-user-access-request-json-http.txt diff --git a/apidocs/src/samples/db-grant-user-access-request.json b/api-ref/source/samples/db-grant-user-access-request.json similarity index 98% rename from apidocs/src/samples/db-grant-user-access-request.json rename to api-ref/source/samples/db-grant-user-access-request.json index 520debdb6d..c7c8b75e11 100644 --- a/apidocs/src/samples/db-grant-user-access-request.json +++ b/api-ref/source/samples/db-grant-user-access-request.json @@ -7,4 +7,4 @@ "name": "databaseD" } ] -} \ No newline at end of file +} diff --git a/apidocs/src/samples/db-grant-user-access-response-json.txt b/api-ref/source/samples/db-grant-user-access-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-grant-user-access-response-json.txt rename to api-ref/source/samples/db-grant-user-access-response-json-http.txt diff --git a/api-ref/source/samples/db-instance-eject-replica-request-json-http.txt b/api-ref/source/samples/db-instance-eject-replica-request-json-http.txt new file mode 100644 index 0000000000..cf3652d103 --- /dev/null +++ b/api-ref/source/samples/db-instance-eject-replica-request-json-http.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/13d940c4-70bb-4ff4-8866-6ee9ab5e5cae/action HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/api-ref/source/samples/db-instance-eject-replica-request.json b/api-ref/source/samples/db-instance-eject-replica-request.json new file mode 100644 index 0000000000..e0d425ad6b --- /dev/null +++ b/api-ref/source/samples/db-instance-eject-replica-request.json @@ -0,0 +1,3 @@ +{ + "eject_replica_source": {} +} diff --git a/api-ref/source/samples/db-instance-promote-replica-request-json-http.txt b/api-ref/source/samples/db-instance-promote-replica-request-json-http.txt new file mode 100644 index 0000000000..cf3652d103 --- /dev/null +++ b/api-ref/source/samples/db-instance-promote-replica-request-json-http.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/13d940c4-70bb-4ff4-8866-6ee9ab5e5cae/action HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/api-ref/source/samples/db-instance-promote-replica-request.json b/api-ref/source/samples/db-instance-promote-replica-request.json new file mode 100644 index 0000000000..f2803b7923 --- /dev/null +++ b/api-ref/source/samples/db-instance-promote-replica-request.json @@ -0,0 +1,3 @@ +{ + "promote_to_replica_source": {} +} diff --git a/apidocs/src/samples/db-instance-reboot-request-json.txt b/api-ref/source/samples/db-instance-reboot-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instance-reboot-request-json.txt rename to api-ref/source/samples/db-instance-reboot-request-json-http.txt diff --git a/apidocs/src/samples/db-instance-reboot-request.json b/api-ref/source/samples/db-instance-reboot-request.json similarity index 95% rename from apidocs/src/samples/db-instance-reboot-request.json rename to api-ref/source/samples/db-instance-reboot-request.json index cc94b40e03..363d866fa0 100644 --- a/apidocs/src/samples/db-instance-reboot-request.json +++ b/api-ref/source/samples/db-instance-reboot-request.json @@ -1,4 +1,3 @@ { "reboot": {} } - diff --git a/apidocs/src/samples/db-instance-reboot-response-json.txt b/api-ref/source/samples/db-instance-reboot-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instance-reboot-response-json.txt rename to api-ref/source/samples/db-instance-reboot-response-json-http.txt diff --git a/apidocs/src/samples/db-instance-resize-flavor-request-json.txt b/api-ref/source/samples/db-instance-resize-flavor-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instance-resize-flavor-request-json.txt rename to api-ref/source/samples/db-instance-resize-flavor-request-json-http.txt diff --git a/apidocs/src/samples/db-instance-resize-flavor-request.json b/api-ref/source/samples/db-instance-resize-flavor-request.json similarity index 98% rename from apidocs/src/samples/db-instance-resize-flavor-request.json rename to api-ref/source/samples/db-instance-resize-flavor-request.json index bb629fe99d..167d8f1f66 100644 --- a/apidocs/src/samples/db-instance-resize-flavor-request.json +++ b/api-ref/source/samples/db-instance-resize-flavor-request.json @@ -3,4 +3,3 @@ "flavorRef": 3 } } - diff --git a/apidocs/src/samples/db-instance-resize-flavor-response-json.txt b/api-ref/source/samples/db-instance-resize-flavor-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instance-resize-flavor-response-json.txt rename to api-ref/source/samples/db-instance-resize-flavor-response-json-http.txt diff --git a/apidocs/src/samples/db-instance-resize-instance-request-json.txt b/api-ref/source/samples/db-instance-resize-instance-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instance-resize-instance-request-json.txt rename to api-ref/source/samples/db-instance-resize-instance-request-json-http.txt diff --git a/apidocs/src/samples/db-instance-resize-instance-request.json b/api-ref/source/samples/db-instance-resize-instance-request.json similarity index 98% rename from apidocs/src/samples/db-instance-resize-instance-request.json rename to api-ref/source/samples/db-instance-resize-instance-request.json index 31a0533ac2..010daa7964 100644 --- a/apidocs/src/samples/db-instance-resize-instance-request.json +++ b/api-ref/source/samples/db-instance-resize-instance-request.json @@ -2,4 +2,4 @@ "resize": { "flavorRef": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2" } -} \ No newline at end of file +} diff --git a/apidocs/src/samples/db-instance-resize-instance-response-json.txt b/api-ref/source/samples/db-instance-resize-instance-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instance-resize-instance-response-json.txt rename to api-ref/source/samples/db-instance-resize-instance-response-json-http.txt diff --git a/apidocs/src/samples/db-instance-resize-volume-request-json.txt b/api-ref/source/samples/db-instance-resize-volume-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instance-resize-volume-request-json.txt rename to api-ref/source/samples/db-instance-resize-volume-request-json-http.txt diff --git a/apidocs/src/samples/db-instance-resize-volume-request.json b/api-ref/source/samples/db-instance-resize-volume-request.json similarity index 98% rename from apidocs/src/samples/db-instance-resize-volume-request.json rename to api-ref/source/samples/db-instance-resize-volume-request.json index 84c99ed82b..949bbba8b4 100644 --- a/apidocs/src/samples/db-instance-resize-volume-request.json +++ b/api-ref/source/samples/db-instance-resize-volume-request.json @@ -5,4 +5,3 @@ } } } - diff --git a/apidocs/src/samples/db-instance-resize-volume-response-json.txt b/api-ref/source/samples/db-instance-resize-volume-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instance-resize-volume-response-json.txt rename to api-ref/source/samples/db-instance-resize-volume-response-json-http.txt diff --git a/apidocs/src/samples/db-instance-restart-request-json.txt b/api-ref/source/samples/db-instance-restart-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instance-restart-request-json.txt rename to api-ref/source/samples/db-instance-restart-request-json-http.txt diff --git a/apidocs/src/samples/db-instance-restart-request.json b/api-ref/source/samples/db-instance-restart-request.json similarity index 95% rename from apidocs/src/samples/db-instance-restart-request.json rename to api-ref/source/samples/db-instance-restart-request.json index 13540b153f..1c92835cd8 100644 --- a/apidocs/src/samples/db-instance-restart-request.json +++ b/api-ref/source/samples/db-instance-restart-request.json @@ -1,4 +1,3 @@ { "restart": {} } - diff --git a/apidocs/src/samples/db-instance-restart-response-json.txt b/api-ref/source/samples/db-instance-restart-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instance-restart-response-json.txt rename to api-ref/source/samples/db-instance-restart-response-json-http.txt diff --git a/apidocs/src/samples/db-instance-status-detail-request-json.txt b/api-ref/source/samples/db-instance-status-detail-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instance-status-detail-request-json.txt rename to api-ref/source/samples/db-instance-status-detail-request-json-http.txt diff --git a/apidocs/src/samples/db-instance-status-detail-response-json.txt b/api-ref/source/samples/db-instance-status-detail-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instance-status-detail-response-json.txt rename to api-ref/source/samples/db-instance-status-detail-response-json-http.txt diff --git a/apidocs/src/samples/db-instance-status-detail-response.json b/api-ref/source/samples/db-instance-status-detail-response.json similarity index 99% rename from apidocs/src/samples/db-instance-status-detail-response.json rename to api-ref/source/samples/db-instance-status-detail-response.json index 807d3a041c..fa96976acb 100644 --- a/apidocs/src/samples/db-instance-status-detail-response.json +++ b/api-ref/source/samples/db-instance-status-detail-response.json @@ -39,4 +39,3 @@ } } } - diff --git a/apidocs/src/samples/db-instances-index-pagination-request-json.txt b/api-ref/source/samples/db-instances-index-pagination-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instances-index-pagination-request-json.txt rename to api-ref/source/samples/db-instances-index-pagination-request-json-http.txt diff --git a/apidocs/src/samples/db-instances-index-pagination-response-json.txt b/api-ref/source/samples/db-instances-index-pagination-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instances-index-pagination-response-json.txt rename to api-ref/source/samples/db-instances-index-pagination-response-json-http.txt diff --git a/apidocs/src/samples/db-instances-index-pagination-response.json b/api-ref/source/samples/db-instances-index-pagination-response.json similarity index 99% rename from apidocs/src/samples/db-instances-index-pagination-response.json rename to api-ref/source/samples/db-instances-index-pagination-response.json index 096834a65f..9dcd84800c 100644 --- a/apidocs/src/samples/db-instances-index-pagination-response.json +++ b/api-ref/source/samples/db-instances-index-pagination-response.json @@ -74,4 +74,3 @@ } ] } - diff --git a/apidocs/src/samples/db-instances-index-request-json.txt b/api-ref/source/samples/db-instances-index-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instances-index-request-json.txt rename to api-ref/source/samples/db-instances-index-request-json-http.txt diff --git a/apidocs/src/samples/db-instances-index-response-json.txt b/api-ref/source/samples/db-instances-index-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-instances-index-response-json.txt rename to api-ref/source/samples/db-instances-index-response-json-http.txt diff --git a/apidocs/src/samples/db-instances-index-response.json b/api-ref/source/samples/db-instances-index-response.json similarity index 99% rename from apidocs/src/samples/db-instances-index-response.json rename to api-ref/source/samples/db-instances-index-response.json index 3123c40782..c644e7c849 100644 --- a/apidocs/src/samples/db-instances-index-response.json +++ b/api-ref/source/samples/db-instances-index-response.json @@ -38,4 +38,3 @@ } ] } - diff --git a/api-ref/source/samples/db-list-cfg-defaults-request-json-http.txt b/api-ref/source/samples/db-list-cfg-defaults-request-json-http.txt new file mode 100644 index 0000000000..bb84c098dc --- /dev/null +++ b/api-ref/source/samples/db-list-cfg-defaults-request-json-http.txt @@ -0,0 +1,7 @@ +GET /v1.0/1234/instances/instance_1 HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + diff --git a/api-ref/source/samples/db-list-cfg-defaults-response-json-http.txt b/api-ref/source/samples/db-list-cfg-defaults-response-json-http.txt new file mode 100644 index 0000000000..dd38b48f74 --- /dev/null +++ b/api-ref/source/samples/db-list-cfg-defaults-response-json-http.txt @@ -0,0 +1,5 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1559 +Date: Wed, 08 Jul 2015 19:53:04 GMT + diff --git a/api-ref/source/samples/db-list-cfg-defaults-response.json b/api-ref/source/samples/db-list-cfg-defaults-response.json new file mode 100644 index 0000000000..58422431f5 --- /dev/null +++ b/api-ref/source/samples/db-list-cfg-defaults-response.json @@ -0,0 +1,44 @@ +{ + "instance": { + "configuration": { + "basedir": "/usr", + "connect_timeout": 15, + "datadir": "/var/lib/mysql/data", + "default_storage_engine": "innodb", + "innodb_buffer_pool_size": "150M", + "innodb_data_file_path": "ibdata1:10M:autoextend", + "innodb_file_per_table": 1, + "innodb_log_buffer_size": "25M", + "innodb_log_file_size": "50M", + "innodb_log_files_in_group": 2, + "join_buffer_size": "1M", + "key_buffer_size": "50M", + "local-infile": 0, + "max_allowed_packet": "1024K", + "max_connections": 100, + "max_heap_table_size": "16M", + "max_user_connections": 100, + "myisam-recover-options": "BACKUP,FORCE", + "open_files_limit": 512, + "performance_schema": "ON", + "pid_file": "/var/run/mysqld/mysqld.pid", + "port": 3306, + "query_cache_limit": "1M", + "query_cache_size": "8M", + "query_cache_type": 1, + "read_buffer_size": "512K", + "read_rnd_buffer_size": "512K", + "server_id": 271898715, + "skip-external-locking": 1, + "sort_buffer_size": "1M", + "table_definition_cache": 256, + "table_open_cache": 256, + "thread_cache_size": "4", + "thread_stack": "192K", + "tmp_table_size": "16M", + "tmpdir": "/var/tmp", + "user": "mysql", + "wait_timeout": "120" + } + } +} diff --git a/api-ref/source/samples/db-list-cfg-groups-request-json-http.txt b/api-ref/source/samples/db-list-cfg-groups-request-json-http.txt new file mode 100644 index 0000000000..f7812e9e6f --- /dev/null +++ b/api-ref/source/samples/db-list-cfg-groups-request-json-http.txt @@ -0,0 +1,7 @@ +GET /v1.0/1234/configurations HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + diff --git a/api-ref/source/samples/db-list-cfg-groups-response-json-http.txt b/api-ref/source/samples/db-list-cfg-groups-response-json-http.txt new file mode 100644 index 0000000000..22bba6af05 --- /dev/null +++ b/api-ref/source/samples/db-list-cfg-groups-response-json-http.txt @@ -0,0 +1,5 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 426 +Date: Tue, 07 Jul 2012 19:53:04 GMT + diff --git a/api-ref/source/samples/db-list-cfg-groups-response.json b/api-ref/source/samples/db-list-cfg-groups-response.json new file mode 100644 index 0000000000..5bdaa990d8 --- /dev/null +++ b/api-ref/source/samples/db-list-cfg-groups-response.json @@ -0,0 +1,14 @@ +{ + "configurations": [ + { + "datastore_name": "mysql", + "updated": "2015-07-01T16:38:27", + "name": "group1", + "created": "2015-07-01T16:38:27", + "datastore_version_name": "5.6", + "id": "2aa51628-5c42-4086-8682-137caffd2ba6", + "datastore_version_id": "2dc7faa0-efff-4c2b-8cff-bcd949c518a5", + "description": null + } + ] +} diff --git a/apidocs/src/samples/db-list-databases-pagination-request-json.txt b/api-ref/source/samples/db-list-databases-pagination-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-list-databases-pagination-request-json.txt rename to api-ref/source/samples/db-list-databases-pagination-request-json-http.txt diff --git a/apidocs/src/samples/db-list-databases-pagination-response-json.txt b/api-ref/source/samples/db-list-databases-pagination-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-list-databases-pagination-response-json.txt rename to api-ref/source/samples/db-list-databases-pagination-response-json-http.txt diff --git a/apidocs/src/samples/db-list-databases-pagination-response.json b/api-ref/source/samples/db-list-databases-pagination-response.json similarity index 99% rename from apidocs/src/samples/db-list-databases-pagination-response.json rename to api-ref/source/samples/db-list-databases-pagination-response.json index 3dc9e46e7e..072e43ee7c 100644 --- a/apidocs/src/samples/db-list-databases-pagination-response.json +++ b/api-ref/source/samples/db-list-databases-pagination-response.json @@ -11,4 +11,3 @@ } ] } - diff --git a/apidocs/src/samples/db-list-databases-request-json.txt b/api-ref/source/samples/db-list-databases-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-list-databases-request-json.txt rename to api-ref/source/samples/db-list-databases-request-json-http.txt diff --git a/apidocs/src/samples/db-list-databases-response-json.txt b/api-ref/source/samples/db-list-databases-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-list-databases-response-json.txt rename to api-ref/source/samples/db-list-databases-response-json-http.txt diff --git a/apidocs/src/samples/db-list-databases-response.json b/api-ref/source/samples/db-list-databases-response.json similarity index 99% rename from apidocs/src/samples/db-list-databases-response.json rename to api-ref/source/samples/db-list-databases-response.json index fe1d5a8705..f2d6ffd8e3 100644 --- a/apidocs/src/samples/db-list-databases-response.json +++ b/api-ref/source/samples/db-list-databases-response.json @@ -17,4 +17,3 @@ } ] } - diff --git a/api-ref/source/samples/db-list-datastore-versions-request-json-http.txt b/api-ref/source/samples/db-list-datastore-versions-request-json-http.txt new file mode 100644 index 0000000000..0763e52149 --- /dev/null +++ b/api-ref/source/samples/db-list-datastore-versions-request-json-http.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/datastores/mysql/versions HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json diff --git a/api-ref/source/samples/db-list-datastore-versions-response-json-http.txt b/api-ref/source/samples/db-list-datastore-versions-response-json-http.txt new file mode 100644 index 0000000000..519dfba192 --- /dev/null +++ b/api-ref/source/samples/db-list-datastore-versions-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 580 +Date: Tue, 23 Jun 2015 21:58:13 GMT diff --git a/api-ref/source/samples/db-list-datastore-versions.json b/api-ref/source/samples/db-list-datastore-versions.json new file mode 100644 index 0000000000..e80e70c0e8 --- /dev/null +++ b/api-ref/source/samples/db-list-datastore-versions.json @@ -0,0 +1,18 @@ +{ + "name": "5.6", + "links": [ + { + "href": "https://10.240.28.38:8779/v1.0/27bee406abb5486e81ef3ff4382aabaf/datastores/versions/2dc7faa0-efff-4c2b-8cff-bcd949c518a5", + "rel": "self" + }, + { + "href": "https://10.240.28.38:8779/datastores/versions/2dc7faa0-efff-4c2b-8cff-bcd949c518a5", + "rel": "bookmark" + } + ], + "image": "b69fbd9e-b31d-46ff-8afb-cbf452f6f835", + "active": 1, + "datastore": "3a8968d8-e5f5-4452-83ca-f6c90b5de06a", + "packages": "mysql-server-5.6", + "id": "2dc7faa0-efff-4c2b-8cff-bcd949c518a5" +} diff --git a/api-ref/source/samples/db-list-parameters-request-json-http.txt b/api-ref/source/samples/db-list-parameters-request-json-http.txt new file mode 100644 index 0000000000..8a07a796f4 --- /dev/null +++ b/api-ref/source/samples/db-list-parameters-request-json-http.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/datastores/versions/692d8418-7a8f-47f1-8060-59846c6e024f/parameters HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json diff --git a/api-ref/source/samples/db-list-parameters-response-json-http.txt b/api-ref/source/samples/db-list-parameters-response-json-http.txt new file mode 100644 index 0000000000..2f37db2645 --- /dev/null +++ b/api-ref/source/samples/db-list-parameters-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 8454 +Date: Fri, 12 Jun 2015 21:58:13 GMT diff --git a/api-ref/source/samples/db-list-parameters-response.json b/api-ref/source/samples/db-list-parameters-response.json new file mode 100644 index 0000000000..7f9153c8a2 --- /dev/null +++ b/api-ref/source/samples/db-list-parameters-response.json @@ -0,0 +1,258 @@ +{ + "configuration-parameters": [ + { + "name": "myisam_sort_buffer_size", + "min": 4096, + "max": 18446744073709552000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "sync_binlog", + "min": 0, + "max": 4294967295, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "max_allowed_packet", + "min": 1024, + "max": 1073741824, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "type": "string", + "name": "character_set_connection", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "name": "autocommit", + "min": 0, + "max": 1, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "type": "string", + "name": "character_set_client", + "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "name": "join_buffer_size", + "min": 128, + "max": 18446744073709548000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "local_infile", + "min": 0, + "max": 1, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "auto_increment_offset", + "min": 1, + "max": 65535, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "max_connections", + "min": 1, + "max": 100000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "bulk_insert_buffer_size", + "min": 0, + "max": 18446744073709552000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef474dac18-2c6abd35a758" + }, + { + "name": "sort_buffer_size", + "min": 32768, + "max": 18446744073709552000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "innodb_log_buffer_size", + "min": 262144, + "max": 4294967295, + "restart_required": true, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "innodb_file_per_table", + "min": 0, + "max": 1, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "type": "string", + "name": "character_set_server", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "name": "innodb_buffer_pool_size", + "min": 5242880, + "max": 18446744073709552000, + "restart_required": true, + "type": "integer", + "datastore_version_id": "f597f709-70ef474dac18-2c6abd35a758" + }, + { + "type": "string", + "name": "collation_server", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "type": "string", + "name": "character_set_filesystem", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "type": "string", + "name": "collation_database", + "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "name": "innodb_flush_log_at_trx_commit", + "min": 0, + "max": 2, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "interactive_timeout", + "min": 1, + "max": 65535, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "max_user_connections", + "min": 0, + "max": 4294967295, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "innodb_thread_concurrency", + "min": 0, + "max": 1000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "innodb_open_files", + "min": 10, + "max": 4294967295, + "restart_required": true, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "key_buffer_size", + "min": 8, + "max": 4294967295, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758" + }, + { + "name": "connect_timeout", + "min": 2, + "max": 31536000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758" + }, + { + "type": "string", + "name": "collation_connection", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "type": "string", + "name": "character_set_database", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "name": "auto_increment_increment", + "min": 1, + "max": 65535, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "max_connect_errors", + "min": 1, + "max": 18446744073709552000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "type": "string", + "name": "character_set_results", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758", + "restart_required": false + }, + { + "name": "expire_logs_days", + "min": 0, + "max": 99, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + }, + { + "name": "wait_timeout", + "min": 1, + "max": 31536000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef474d-ac18-2c6abd35a758" + }, + { + "name": "server_id", + "min": 0, + "max": 4294967295, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f597f709-70ef-474d-ac18-2c6abd35a758" + } + ] +} diff --git a/apidocs/src/samples/db-list-user-access-request-json.txt b/api-ref/source/samples/db-list-user-access-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-list-user-access-request-json.txt rename to api-ref/source/samples/db-list-user-access-request-json-http.txt diff --git a/apidocs/src/samples/db-list-user-access-response-json.txt b/api-ref/source/samples/db-list-user-access-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-list-user-access-response-json.txt rename to api-ref/source/samples/db-list-user-access-response-json-http.txt diff --git a/apidocs/src/samples/db-list-user-access-response.json b/api-ref/source/samples/db-list-user-access-response.json similarity index 98% rename from apidocs/src/samples/db-list-user-access-response.json rename to api-ref/source/samples/db-list-user-access-response.json index 65cc4ff408..38c6b9db84 100644 --- a/apidocs/src/samples/db-list-user-access-response.json +++ b/api-ref/source/samples/db-list-user-access-response.json @@ -7,4 +7,4 @@ "name": "databaseB" } ] -} \ No newline at end of file +} diff --git a/apidocs/src/samples/db-list-user-dbs-request-json.txt b/api-ref/source/samples/db-list-user-dbs-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-list-user-dbs-request-json.txt rename to api-ref/source/samples/db-list-user-dbs-request-json-http.txt diff --git a/apidocs/src/samples/db-list-user-dbs-response-json.txt b/api-ref/source/samples/db-list-user-dbs-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-list-user-dbs-response-json.txt rename to api-ref/source/samples/db-list-user-dbs-response-json-http.txt diff --git a/apidocs/src/samples/db-list-user-dbs-response.json b/api-ref/source/samples/db-list-user-dbs-response.json similarity index 99% rename from apidocs/src/samples/db-list-user-dbs-response.json rename to api-ref/source/samples/db-list-user-dbs-response.json index fc5b83232e..e303ad02fd 100644 --- a/apidocs/src/samples/db-list-user-dbs-response.json +++ b/api-ref/source/samples/db-list-user-dbs-response.json @@ -10,4 +10,4 @@ } ] } -} \ No newline at end of file +} diff --git a/apidocs/src/samples/db-list-users-pagination-request-json.txt b/api-ref/source/samples/db-list-users-pagination-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-list-users-pagination-request-json.txt rename to api-ref/source/samples/db-list-users-pagination-request-json-http.txt diff --git a/apidocs/src/samples/db-list-users-pagination-response-json.txt b/api-ref/source/samples/db-list-users-pagination-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-list-users-pagination-response-json.txt rename to api-ref/source/samples/db-list-users-pagination-response-json-http.txt diff --git a/apidocs/src/samples/db-list-users-pagination-response.json b/api-ref/source/samples/db-list-users-pagination-response.json similarity index 99% rename from apidocs/src/samples/db-list-users-pagination-response.json rename to api-ref/source/samples/db-list-users-pagination-response.json index eebba6fb75..d211c90fa0 100644 --- a/apidocs/src/samples/db-list-users-pagination-response.json +++ b/api-ref/source/samples/db-list-users-pagination-response.json @@ -29,4 +29,3 @@ } ] } - diff --git a/apidocs/src/samples/db-list-users-request-json.txt b/api-ref/source/samples/db-list-users-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-list-users-request-json.txt rename to api-ref/source/samples/db-list-users-request-json-http.txt diff --git a/apidocs/src/samples/db-list-users-response-json.txt b/api-ref/source/samples/db-list-users-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-list-users-response-json.txt rename to api-ref/source/samples/db-list-users-response-json-http.txt diff --git a/apidocs/src/samples/db-list-users-response.json b/api-ref/source/samples/db-list-users-response.json similarity index 99% rename from apidocs/src/samples/db-list-users-response.json rename to api-ref/source/samples/db-list-users-response.json index ed0a0c6a01..80318d2cf7 100644 --- a/apidocs/src/samples/db-list-users-response.json +++ b/api-ref/source/samples/db-list-users-response.json @@ -41,4 +41,3 @@ } ] } - diff --git a/apidocs/src/samples/db-mgmt-get-account-details-request-json.txt b/api-ref/source/samples/db-mgmt-get-account-details-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-get-account-details-request-json.txt rename to api-ref/source/samples/db-mgmt-get-account-details-request-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-get-account-details-response-json.txt b/api-ref/source/samples/db-mgmt-get-account-details-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-get-account-details-response-json.txt rename to api-ref/source/samples/db-mgmt-get-account-details-response-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-get-account-details-response.json b/api-ref/source/samples/db-mgmt-get-account-details-response.json similarity index 99% rename from apidocs/src/samples/db-mgmt-get-account-details-response.json rename to api-ref/source/samples/db-mgmt-get-account-details-response.json index e2cadb8b2e..ff0294a90b 100644 --- a/apidocs/src/samples/db-mgmt-get-account-details-response.json +++ b/api-ref/source/samples/db-mgmt-get-account-details-response.json @@ -6,4 +6,3 @@ ] } } - diff --git a/apidocs/src/samples/db-mgmt-get-host-detail-request-json.txt b/api-ref/source/samples/db-mgmt-get-host-detail-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-get-host-detail-request-json.txt rename to api-ref/source/samples/db-mgmt-get-host-detail-request-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-get-host-detail-response-json.txt b/api-ref/source/samples/db-mgmt-get-host-detail-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-get-host-detail-response-json.txt rename to api-ref/source/samples/db-mgmt-get-host-detail-response-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-get-host-detail-response.json b/api-ref/source/samples/db-mgmt-get-host-detail-response.json similarity index 100% rename from apidocs/src/samples/db-mgmt-get-host-detail-response.json rename to api-ref/source/samples/db-mgmt-get-host-detail-response.json diff --git a/apidocs/src/samples/db-mgmt-get-instance-details-request-json.txt b/api-ref/source/samples/db-mgmt-get-instance-details-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-get-instance-details-request-json.txt rename to api-ref/source/samples/db-mgmt-get-instance-details-request-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-get-instance-details-response-json.txt b/api-ref/source/samples/db-mgmt-get-instance-details-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-get-instance-details-response-json.txt rename to api-ref/source/samples/db-mgmt-get-instance-details-response-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-get-instance-details-response.json b/api-ref/source/samples/db-mgmt-get-instance-details-response.json similarity index 99% rename from apidocs/src/samples/db-mgmt-get-instance-details-response.json rename to api-ref/source/samples/db-mgmt-get-instance-details-response.json index 4e6093b9c2..c58aeb20e3 100644 --- a/apidocs/src/samples/db-mgmt-get-instance-details-response.json +++ b/api-ref/source/samples/db-mgmt-get-instance-details-response.json @@ -77,4 +77,3 @@ } } } - diff --git a/apidocs/src/samples/db-mgmt-get-root-details-request-json.txt b/api-ref/source/samples/db-mgmt-get-root-details-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-get-root-details-request-json.txt rename to api-ref/source/samples/db-mgmt-get-root-details-request-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-get-root-details-response-json.txt b/api-ref/source/samples/db-mgmt-get-root-details-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-get-root-details-response-json.txt rename to api-ref/source/samples/db-mgmt-get-root-details-response-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-get-root-details-response.json b/api-ref/source/samples/db-mgmt-get-root-details-response.json similarity index 99% rename from apidocs/src/samples/db-mgmt-get-root-details-response.json rename to api-ref/source/samples/db-mgmt-get-root-details-response.json index 701aa75475..6238286f0a 100644 --- a/apidocs/src/samples/db-mgmt-get-root-details-response.json +++ b/api-ref/source/samples/db-mgmt-get-root-details-response.json @@ -5,4 +5,3 @@ "user": "3000" } } - diff --git a/apidocs/src/samples/db-mgmt-get-storage-request-json.txt b/api-ref/source/samples/db-mgmt-get-storage-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-get-storage-request-json.txt rename to api-ref/source/samples/db-mgmt-get-storage-request-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-get-storage-response-json.txt b/api-ref/source/samples/db-mgmt-get-storage-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-get-storage-response-json.txt rename to api-ref/source/samples/db-mgmt-get-storage-response-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-get-storage-response.json b/api-ref/source/samples/db-mgmt-get-storage-response.json similarity index 99% rename from apidocs/src/samples/db-mgmt-get-storage-response.json rename to api-ref/source/samples/db-mgmt-get-storage-response.json index 7f0ef02067..7e634d929c 100644 --- a/apidocs/src/samples/db-mgmt-get-storage-response.json +++ b/api-ref/source/samples/db-mgmt-get-storage-response.json @@ -16,4 +16,3 @@ } ] } - diff --git a/apidocs/src/samples/db-mgmt-instance-diagnostics-request-json.txt b/api-ref/source/samples/db-mgmt-instance-diagnostics-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-instance-diagnostics-request-json.txt rename to api-ref/source/samples/db-mgmt-instance-diagnostics-request-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-instance-diagnostics-response-json.txt b/api-ref/source/samples/db-mgmt-instance-diagnostics-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-instance-diagnostics-response-json.txt rename to api-ref/source/samples/db-mgmt-instance-diagnostics-response-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-instance-diagnostics-response.json b/api-ref/source/samples/db-mgmt-instance-diagnostics-response.json similarity index 99% rename from apidocs/src/samples/db-mgmt-instance-diagnostics-response.json rename to api-ref/source/samples/db-mgmt-instance-diagnostics-response.json index cca48f4e42..7e618429e9 100644 --- a/apidocs/src/samples/db-mgmt-instance-diagnostics-response.json +++ b/api-ref/source/samples/db-mgmt-instance-diagnostics-response.json @@ -9,4 +9,3 @@ "vmSize": 29096 } } - diff --git a/apidocs/src/samples/db-mgmt-instance-index-request-json.txt b/api-ref/source/samples/db-mgmt-instance-index-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-instance-index-request-json.txt rename to api-ref/source/samples/db-mgmt-instance-index-request-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-instance-index-response-json.txt b/api-ref/source/samples/db-mgmt-instance-index-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-instance-index-response-json.txt rename to api-ref/source/samples/db-mgmt-instance-index-response-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-instance-index-response.json b/api-ref/source/samples/db-mgmt-instance-index-response.json similarity index 99% rename from apidocs/src/samples/db-mgmt-instance-index-response.json rename to api-ref/source/samples/db-mgmt-instance-index-response.json index db0450f803..9c6eb89f3a 100644 --- a/apidocs/src/samples/db-mgmt-instance-index-response.json +++ b/api-ref/source/samples/db-mgmt-instance-index-response.json @@ -55,4 +55,3 @@ } ] } - diff --git a/apidocs/src/samples/db-mgmt-list-accounts-request-json.txt b/api-ref/source/samples/db-mgmt-list-accounts-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-list-accounts-request-json.txt rename to api-ref/source/samples/db-mgmt-list-accounts-request-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-list-accounts-response-json.txt b/api-ref/source/samples/db-mgmt-list-accounts-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-list-accounts-response-json.txt rename to api-ref/source/samples/db-mgmt-list-accounts-response-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-list-accounts-response.json b/api-ref/source/samples/db-mgmt-list-accounts-response.json similarity index 99% rename from apidocs/src/samples/db-mgmt-list-accounts-response.json rename to api-ref/source/samples/db-mgmt-list-accounts-response.json index 0187fb5c20..099a6a509c 100644 --- a/apidocs/src/samples/db-mgmt-list-accounts-response.json +++ b/api-ref/source/samples/db-mgmt-list-accounts-response.json @@ -6,4 +6,3 @@ } ] } - diff --git a/apidocs/src/samples/db-mgmt-list-hosts-request-json.txt b/api-ref/source/samples/db-mgmt-list-hosts-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-list-hosts-request-json.txt rename to api-ref/source/samples/db-mgmt-list-hosts-request-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-list-hosts-response-json.txt b/api-ref/source/samples/db-mgmt-list-hosts-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-mgmt-list-hosts-response-json.txt rename to api-ref/source/samples/db-mgmt-list-hosts-response-json-http.txt diff --git a/apidocs/src/samples/db-mgmt-list-hosts-response.json b/api-ref/source/samples/db-mgmt-list-hosts-response.json similarity index 99% rename from apidocs/src/samples/db-mgmt-list-hosts-response.json rename to api-ref/source/samples/db-mgmt-list-hosts-response.json index 3fe0eb5270..6972dcd6a5 100644 --- a/apidocs/src/samples/db-mgmt-list-hosts-response.json +++ b/api-ref/source/samples/db-mgmt-list-hosts-response.json @@ -10,4 +10,3 @@ } ] } - diff --git a/api-ref/source/samples/db-patch-config-group-request-json-http.txt b/api-ref/source/samples/db-patch-config-group-request-json-http.txt new file mode 100644 index 0000000000..3606caefb5 --- /dev/null +++ b/api-ref/source/samples/db-patch-config-group-request-json-http.txt @@ -0,0 +1,7 @@ +PATCH /v1.0/1234/configurations/5678 HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: d6cafa5b-e0c7-4ab8-948e-7c95f2acd031 +Accept: application/json +Content-Type: application/json + diff --git a/api-ref/source/samples/db-patch-config-group-request.json b/api-ref/source/samples/db-patch-config-group-request.json new file mode 100644 index 0000000000..bdb87bd485 --- /dev/null +++ b/api-ref/source/samples/db-patch-config-group-request.json @@ -0,0 +1,7 @@ +{ + "configuration": { + "values": { + "connect_timeout": 17 + } + } +} diff --git a/api-ref/source/samples/db-patch-config-group-response-json-http.txt b/api-ref/source/samples/db-patch-config-group-response-json-http.txt new file mode 100644 index 0000000000..244b32fb48 --- /dev/null +++ b/api-ref/source/samples/db-patch-config-group-response-json-http.txt @@ -0,0 +1,5 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 0 +Date: Mon, 6 Jul 2015 21:53:10 GMT + diff --git a/apidocs/src/samples/db-restore-delete-request-json.txt b/api-ref/source/samples/db-restore-delete-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-restore-delete-request-json.txt rename to api-ref/source/samples/db-restore-delete-request-json-http.txt diff --git a/apidocs/src/samples/db-restore-delete-response-json.txt b/api-ref/source/samples/db-restore-delete-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-restore-delete-response-json.txt rename to api-ref/source/samples/db-restore-delete-response-json-http.txt diff --git a/apidocs/src/samples/db-revoke-user-access-request-json.txt b/api-ref/source/samples/db-revoke-user-access-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-revoke-user-access-request-json.txt rename to api-ref/source/samples/db-revoke-user-access-request-json-http.txt diff --git a/apidocs/src/samples/db-revoke-user-access-response-json.txt b/api-ref/source/samples/db-revoke-user-access-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-revoke-user-access-response-json.txt rename to api-ref/source/samples/db-revoke-user-access-response-json-http.txt diff --git a/api-ref/source/samples/db-show-parameter-details-request-json-http.txt b/api-ref/source/samples/db-show-parameter-details-request-json-http.txt new file mode 100644 index 0000000000..a5e30777b5 --- /dev/null +++ b/api-ref/source/samples/db-show-parameter-details-request-json-http.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/datastores/versions/f8e67741-e767-4137-b394-3fb8a3fafd2f/parameters/connect_timeout HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json diff --git a/api-ref/source/samples/db-show-parameter-details-response-json-http.txt b/api-ref/source/samples/db-show-parameter-details-response-json-http.txt new file mode 100644 index 0000000000..35d4ca06d9 --- /dev/null +++ b/api-ref/source/samples/db-show-parameter-details-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 180 +Date: Tue, 16 Jun 2015 21:58:13 GMT diff --git a/api-ref/source/samples/db-show-parameter-details.json b/api-ref/source/samples/db-show-parameter-details.json new file mode 100644 index 0000000000..6da77f15ff --- /dev/null +++ b/api-ref/source/samples/db-show-parameter-details.json @@ -0,0 +1,8 @@ +{ + "name": "connect_timeout", + "min": 2, + "max": 31536000, + "restart_required": false, + "type": "integer", + "datastore_version_id": "f8e67741-e767-4137-b394-3fb8a3fafd2f" +} diff --git a/api-ref/source/samples/db-update-config-group-request-json-http.txt b/api-ref/source/samples/db-update-config-group-request-json-http.txt new file mode 100644 index 0000000000..c9549a2c62 --- /dev/null +++ b/api-ref/source/samples/db-update-config-group-request-json-http.txt @@ -0,0 +1,7 @@ +PUT /v1.0/1234/configurations/5678 HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: d6cafa5b-e0c7-4ab8-948e-7c95f2acd031 +Accept: application/json +Content-Type: application/json + diff --git a/api-ref/source/samples/db-update-config-group-request.json b/api-ref/source/samples/db-update-config-group-request.json new file mode 100644 index 0000000000..f98de45d0d --- /dev/null +++ b/api-ref/source/samples/db-update-config-group-request.json @@ -0,0 +1,9 @@ +{ + "configuration": { + "values": { + "connect_timeout": 18 + }, + "name": "new_name", + "description": "New description" + } +} diff --git a/api-ref/source/samples/db-update-config-group-response-json-http.txt b/api-ref/source/samples/db-update-config-group-response-json-http.txt new file mode 100644 index 0000000000..13027ba4d4 --- /dev/null +++ b/api-ref/source/samples/db-update-config-group-response-json-http.txt @@ -0,0 +1,5 @@ +HTTP/1.1 202 OK +Content-Type: application/json +Content-Length: 0 +Date: Mon, 6 Jul 2015 21:53:10 GMT + diff --git a/apidocs/src/samples/db-version-request-json.txt b/api-ref/source/samples/db-version-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-version-request-json.txt rename to api-ref/source/samples/db-version-request-json-http.txt diff --git a/apidocs/src/samples/db-version-response-json.txt b/api-ref/source/samples/db-version-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-version-response-json.txt rename to api-ref/source/samples/db-version-response-json-http.txt diff --git a/apidocs/src/samples/db-version-response.json b/api-ref/source/samples/db-version-response.json similarity index 99% rename from apidocs/src/samples/db-version-response.json rename to api-ref/source/samples/db-version-response.json index ce459bbf4b..fb1e7acbfd 100644 --- a/apidocs/src/samples/db-version-response.json +++ b/api-ref/source/samples/db-version-response.json @@ -10,4 +10,4 @@ "status": "CURRENT", "updated": "2012-01-01T00:00:00Z" } -} \ No newline at end of file +} diff --git a/apidocs/src/samples/db-versions-request-json.txt b/api-ref/source/samples/db-versions-request-json-http.txt similarity index 100% rename from apidocs/src/samples/db-versions-request-json.txt rename to api-ref/source/samples/db-versions-request-json-http.txt diff --git a/apidocs/src/samples/db-versions-response-json.txt b/api-ref/source/samples/db-versions-response-json-http.txt similarity index 100% rename from apidocs/src/samples/db-versions-response-json.txt rename to api-ref/source/samples/db-versions-response-json-http.txt diff --git a/apidocs/src/samples/db-versions-response.json b/api-ref/source/samples/db-versions-response.json similarity index 99% rename from apidocs/src/samples/db-versions-response.json rename to api-ref/source/samples/db-versions-response.json index 5bfe6d6186..4cd81df93a 100644 --- a/apidocs/src/samples/db-versions-response.json +++ b/api-ref/source/samples/db-versions-response.json @@ -12,4 +12,4 @@ "updated": "2012-01-01T00:00:00Z" } ] -} \ No newline at end of file +} diff --git a/api-ref/source/user-management.inc b/api-ref/source/user-management.inc new file mode 100644 index 0000000000..28970bf651 --- /dev/null +++ b/api-ref/source/user-management.inc @@ -0,0 +1,363 @@ +.. -*- rst -*- + +============= +Users (users) +============= + +Creates, lists all, and deletes users. + + +Enable root user +================ + +.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/root + +Enables the root user for a database instance and returns the root password. + +This operation generates a root password for the root user and +enables the root user to log in from any host. + +Changes that you make as a root user can impact the database +instance and API operations in unpredictable and detrimental ways. +When you enable the root user, you accept the possibility that we +cannot support your database instance. We might not be able to +assist you if you change core MySQL settings. These changes can be, +but are not limited to, turning off bin logs, removing users that +we use to access your instance, and so on. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-enable-root-user-response.json + :language: javascript + + + + + + + + + + + + + + +Show root-enabled status for database instance +============================================== + +.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/root + +Shows root-enabled status for a database instance. + +Returns ``true`` if root user is enabled for a database instance. +Otherwise, returns ``false``. + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-check-root-user-response.json + :language: javascript + + + + + + + + + + + + + + +Disable root user +================= + +.. rest_method:: DELETE /v1.0/{accountId}/instances/{instanceId}/root + +Disables the root user. + +Error response codes:202,413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + + + + + + + + + + + + + + + + +Delete user +=========== + +.. rest_method:: DELETE /v1.0/{accountId}/instances/{instanceId}/users/{name} + +Deletes a user for a database instance. + +Do not use periods in user names. A bug in a Python library that +Rackspace uses that can cause incorrect user deletions to occur if +you use a period (.) in the user name. In this case, the bug in the +library truncates the user name to the portion from the beginning +up to the period. For example, for the ``my.userA`` user, the bug +truncates the user name to ``my``, and if the ``user`` exists, that +user is incorrectly deleted. + +Error response codes:202,413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + + + + + + + + + + + + + + + + +Create user +=========== + +.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/users + +Creates a user for a database instance. + +Asynchronously provisions a new user for the database instance by +using the configuration that you define in the request object. +After the API validates the request and starts progress on the +provisioning process, the call returns the ``Accepted (202)`` +response code. + +If the API cannot fulfill the corresponding request due to +insufficient data or data that is not valid, the API returns the +``Bad Request (400)`` response code with information about the +nature of the failure. You cannot recover from validation errors. +You must correct the cause of the failure and the request again. + +This table lists the required attributes for creating users: + +**Required attributes for user** + ++-----------------+---------------------------------------------------------------------+------------------------------------+----------+ +| Applies to | Name | Description | Required | ++-----------------+---------------------------------------------------------------------+------------------------------------+----------+ +| User | name | Name of the user for the database. | Yes | ++-----------------+---------------------------------------------------------------------+------------------------------------+----------+ +| password | User password for database access. | Yes | | ++-----------------+---------------------------------------------------------------------+------------------------------------+----------+ +| (database) name | Name of the database that the user can access. You must specify one | No | | +| | or more database names. | | | ++-----------------+---------------------------------------------------------------------+------------------------------------+----------+ + + **Notes** + +- The operation grants the user all privileges on the databases. + +- Do not use the ``root`` user name, which is reserved. + +These tables list the valid characters for database names, user +names, and passwords. + +**Valid characters in database name, user name, and password** + ++---------------------------------------------------------------------------------------------------------------------------------+ +| Character | ++---------------------------------------------------------------------------------------------------------------------------------+ +| Letters (upper and lower cases allowed) | ++---------------------------------------------------------------------------------------------------------------------------------+ +| Numbers | ++---------------------------------------------------------------------------------------------------------------------------------+ +| ``@``, ``?``, ``#``, and spaces are allowed, but **not** at the beginning and end of the database name, user name, and password | ++---------------------------------------------------------------------------------------------------------------------------------+ +| ``_`` is allowed anywhere in the database name, user name, and password | ++---------------------------------------------------------------------------------------------------------------------------------+ + +**Characters that are not allowed in database name, user name, and password** + ++---------------------------------------------------------+ +| Character | ++---------------------------------------------------------+ +| Single quotes | ++---------------------------------------------------------+ +| Double quotes | ++---------------------------------------------------------+ +| Back quotes | ++---------------------------------------------------------+ +| Semicolons | ++---------------------------------------------------------+ +| Commas | ++---------------------------------------------------------+ +| Back slashes | ++---------------------------------------------------------+ +| Forward slashes | ++---------------------------------------------------------+ +| Spaces at the front or end of the user name or password | ++---------------------------------------------------------+ + +**Length restrictions for database name, user name, and password** + ++------------------------------+-----------------------------+ +| Restriction | Value | ++------------------------------+-----------------------------+ +| Database name maximum length | 64 | ++------------------------------+-----------------------------+ +| User name maximum length | 16 | ++------------------------------+-----------------------------+ +| Password maximum length | unlimited (no restrictions) | ++------------------------------+-----------------------------+ + +Error response codes:202,413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + +Request Example +--------------- + +.. literalinclude:: samples/db-create-users-request.json + :language: javascript + + + + + + + + + + + + + + + + + +List database instance users +============================ + +.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/users + +Lists the users in a database instance and the associated databases for that user. + +This operation does not return system users. A system user is a +database administrator who administers the health of the database. +Also, this operation returns the ``root`` user only if it is +enabled. + +The following notes apply to MySQL users: + +- User names can be up to 16 characters long. + +- When you create accounts with INSERT, you must use FLUSH + PRIVILEGES to tell the server to reload the grant tables. + +- For additional information, See: + `http://dev.mysql.com/doc/refman/5.1/en/user-account- + management.html `_ + + +Normal response codes: 200 +Error response codes:413,405,404,403,401,400,422,503,500,501, + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - instanceId: instanceId + - accountId: accountId + + + + +Response Example +---------------- + +.. literalinclude:: samples/db-list-users-response.json + :language: javascript + + + + + + + + + + + + + diff --git a/apidocs/.gitignore b/apidocs/.gitignore deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/apidocs/pom.xml b/apidocs/pom.xml deleted file mode 100644 index 4d5260823c..0000000000 --- a/apidocs/pom.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - 4.0.0 - com.rackspace.cloud.dbaas - dbaas-docs - 1.0.0-SNAPSHOT - Database Public API Spec - jar - - - net.sourceforge.saxon - saxon - 9.1.0.8 - - - com.rackspace.cloud.api - wadl-tools - 1.0.9 - - - - - - com.rackspace.cloud.api - clouddocs-maven-plugin - - - 2.0.2 - - - cdb-devguide - - generate-webhelp - - generate-sources - - src - false - 2 - - - 0 - UA-23102455-4 - cdb-devguide.xml - http://docs.openstack.org/api/openstack-database/content - mike.asthalter@rackspace.com - - - - - 1 - mike.asthalter@rackspace.com - openstack - - - - - - org.apache.maven.plugins - maven-dependency-plugin - - - unpack-shared-resources - - unpack-dependencies - - generate-sources - - ${project.build.directory}/generated-resources - com.rackspace.cloud.api - wadl-tools - true - **/xsl/*.xsl - - - - - - - org.apache.maven.plugins - maven-antrun-plugin - 1.5 - - - ant - generate-sources - - - - - - - - - - - - - - - - - - - - - - - - - - - run - - - - - - org.apache.maven.plugins - maven-assembly-plugin - 2.3 - - - includewars.xml - - - - - assembly - - single - - package - - - - - - - - Rackspace Research Repositories - - true - - - - rackspace-research - Rackspace Research Repository - https://maven.research.rackspacecloud.com/content/groups/public/ - - - - - rackspace-research - Rackspace Research Repository - https://maven.research.rackspacecloud.com/content/groups/public/ - - - - - diff --git a/apidocs/replacements.config b/apidocs/replacements.config deleted file mode 100644 index e595a773e5..0000000000 --- a/apidocs/replacements.config +++ /dev/null @@ -1,6 +0,0 @@ -XPATH=//text() -accountId->tenantId -accountID->tenantID -account ID->tenant ID -ord.databases.api.rackspacecloud.com->openstack.example.com -.*Repose.*\n-> \ No newline at end of file diff --git a/apidocs/src/cdb-devguide.xml b/apidocs/src/cdb-devguide.xml deleted file mode 100644 index bae83ea6f1..0000000000 --- a/apidocs/src/cdb-devguide.xml +++ /dev/null @@ -1,924 +0,0 @@ - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - - - - - - - '> - - - - - - '> -]> - - - - OpenStack Cloud Databases Developer Guide - OpenStack Cloud Databases Developer - Guide - - - - - - - - OpenStack Foundation - - - - 2010 - 2011 - 2012 - 2013 - OpenStack Foundation - - API v1.0 - OpenStack Cloud Databases - - - - Copyright details are filled in by the - template. - - - - This document is intended for software developers - interested in developing applications using the - OpenStack Cloud Databases Application Programming - Interface (API). - - - - - 2013-05-02 - - - - This document is for the initial - OpenStack review. - - - - - - - - this is a placeholder for the front cover - - - this is a placeholder for the back cover - - - API Developer Guide - cdb - 20 - - - - Overview - OpenStack Cloud Databases is an OpenStack-based MySQL - relational database service that allows customers to - easily provision database instances of varying virtual - resource sizes without the need to maintain and/or update - MySQL. Interactions with Cloud Databases occur - programmatically via the Cloud Databases API as described - in this developer guide. - - OpenStack recommends that Cloud Databases users back - up their data using mysqldump until backups are supported - in Cloud Databases. - - The following figure shows an overview of Cloud - Databases Infrastructure: - - - - - - - - Reviewer: need to edit graphic - above so it says "The Cloud" rather than "The Rackspace - Cloud". - -
- Intended Audience - This Guide is intended to assist software developers - who want to develop applications using the Cloud - Databases API. It assumes the reader has a general - understanding of databases and is familiar - with: - - - ReSTful web services - - - HTTP/1.1 conventions - - - JSON data serialization - format - - -
- -
- Document Change History - This version of the Developer Guide replaces and - obsoletes all previous versions. The most recent - changes are described in the table below: - -
-
- Additional Resources - You can download the most current versions of this - and other API-related documents from http://docs.openstack.org/. - We welcome feedback, comments, and bug reports at - https://bugs.launchpad.net/reddwarf. - This API uses standard HTTP 1.1 response codes as - documented at: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html. -
- - - - - Concepts - - To use the Cloud Databases API effectively, you should - understand several key concepts: -
- Database Instance - A database instance is an isolated MySQL instance in - a single tenant environment on a shared physical host - machine. - Writer: once we support - MSSQL, we need to describe here what is used for MSSQL - in place of database instance. -
-
- Database - A MySQL database within a database instance. - Writer: once we support - MSSQL, we need to modify the wording here, such as: - The actual database, whether it is in MySQL or - MSSQL. -
-
- Flavor - A flavor is an available hardware configuration for - a database instance. Each flavor has a unique - combination of memory capacity and priority for CPU - time. -
-
- Volume - A volume is user-specified storage that contains the - MySQL data directory. Volumes are automatically - provisioned on shared Internet Small Computer System - Interface (iSCSI) storage area networks (SAN) that - provide for increased performance, scalability, - availability and manageability. Applications with high - I/O demands are performance optimized and data is - protected through both local and network RAID-10. - Additionally, network RAID provides synchronous - replication of volumes with automatic failover and - load balancing across available storage - clusters. -
- - - General API Information - The Cloud Databases API is implemented using a ReSTful - web service interface. Like other cloud products, the - Database Service shares a common token-based - authentication system that allows seamless access between - products and services. - - All requests to authenticate against and operate the - service are performed using SSL over HTTP (HTTPS) on - TCP port 443. - -
- Authentication - Each HTTP request against the Cloud Database service - requires the inclusion of specific authentication - credentials. A single deployment may support multiple - authentication schemes (OAuth, Basic Auth, Token). The - authentication scheme used is determined by the - provider of the Cloud Database service. Please contact - your provider to determine the best way to - authenticate against this API. - - Some authentication schemes may require that the - API operate using SSL over HTTP (HTTPS). - -
-
- Cloud Databases Service Versions - The Cloud Databases version defines the contract and - build information for the API. -
- Contract Version - The contract version denotes the data model and - behavior that the API supports. The requested - contract version is included in all request URLs. - Different contract versions of the API may be - available at any given time and are not guaranteed - to be compatible with one another. - - Example Request URL (contract version in - <emphasis role="strong" - >bold</emphasis>) - https://ord.databases.api.rackspacecloud.com/v1.0/1234 - - - This document pertains to contract version - 1.0. - - -
-
- API Version - The API List Versions call is available to show - the current API version as well as information - about all versions of the API. Refer to for details. -
-
- -
- Date/Time Format - The Database Service uses an ISO-8601 compliant date - format for the display and consumption of date/time - values. - The system timezone is in UTC. MySQL converts - TIMESTAMP values from the current time zone to UTC for - storage, and back from UTC to the current time zone - for retrieval. This does not occur for other types, - such as DATETIME. - - DB Service Date/Time Format - yyyy-MM-dd'T'HH:mm:ss.SSSZ - See the table below for a description of the - date/time format codes. - May 19th, 2011 at 8:07:08 AM, GMT-5 would have - the following format: - 2011-05-19T08:07:08-05:00 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Explanation of Date/Time Format - Codes
CodeDescription
yyyyFour digit year
MMTwo digit month
ddTwo digit day of month
TSeparator for date/time
HHTwo digit hour of day (00-23)
mmTwo digit minutes of hour
ssTwo digit seconds of the minute
SSSThree digit milliseconds of the - second
ZRFC-822 timezone
- -
-
- Pagination - To reduce load on the service, list operations - return a maximum of 20 items at a time. This is - referred to as pagination. Cloud - Databases has separate paging limits for instances, - databases, and users, which are currently all set to - 20. If a request supplies no limit or one that exceeds - the configured default limit, the default is used - instead. - Pagination provides the ability to limit the size of - the returned data as well as retrieve a specified - subset of a large data set. Pagination has two key - concepts: limit and marker. Limit - is the restriction on the maximum number of items for - that type that can be returned. - Marker is the ID of the last - item in the previous list returned. The ID is the UUID - in the case of instances, and the name in the case of - databases and users. For example, a query could - request the next 10 instances after the instance - "1234" as follows: - ?limit=10&marker=1234. Items are - displayed sorted by ID. - Pagination applies only to the calls listed in the - following table: - - - - Verb - URI - Description - - - - - &GET; - /instances/ - Lists the status and - information for all database - instances. - - - &GET; - - /instances/{instanceId}/databases - Lists databases for the - specified instance. - - - &GET; - - /instances/{instanceId}/users - Lists the users in the - specified database instance. - - - - If the content returned by a call is paginated, the - response includes a structured link much like an - instance item's links, with the basic structure - {"href": "<url>", "rel": "next"}. - Any response that is truncated by pagination will have - a next link, which points to the - next item in the collection. If there are no more - items, no next link is - returned. - See the examples of paged List Instances calls that - follow. - Reviewer: Need new examples - that show OpenStack host. - - List Instances Paged Request: JSON - - - - Notice that the paged request examples above set the - limit to 2 (?limit=2), so the responses - that follow each show 2 instances and return a - marker set to the UUID of the - last item in the returned list - (?marker=4137d6a4-03b7-4b66-b0ef-8c7c35c470d3). - Also a link is provided to retrieve the next 2 results - (limit=2) in the link element - identified by "rel":"next": - - List Instances Paged Response: JSON - - HTTP/1.1 200 OK -Content-Type: application/json -Via: 1.1 Repose (Repose/2.6.7) -Content-Length: 1172 -Date: Mon, 18 Mar 2013 19:09:17 GMT -Server: Jetty(8.0.y.z-SNAPSHOT) - - -
-
- Faults - When an error occurs, the Database Service returns a - fault object containing an HTTP error response code - that denotes the type of error. In the body of the - response, the system will return additional - information about the fault. - The following table lists possible fault types with - their associated error codes and descriptions. - - - - Fault Type - Associated Error Code - Description - - - - - badRequest - 400 - There was one or more errors - in the user request. - - - unauthorized - 401 - The supplied token is not - authorized to access the resources, either - it's expired or invalid. - - - forbidden - 403 - Access to the requested - resource was denied. - - - itemNotFound - 404 - The back-end services did not - find anything matching the - Request-URI. - - - badMethod - 405 - The request method is not - allowed for this resource. - - - overLimit - 413 - Either the number of entities - in the request is larger than allowed - limits, or the user has exceeded allowable - request rate limits. See the - details element for more - specifics. Contact support if you think - you need higher request rate limits. - - - badMediaType - 415 - The requested content type is - not supported by this service. - - - unprocessableEntity - 422 - The requested resource could - not be processed on at the moment. - - - instanceFault - 500 - This is a generic server error - and the message contains the reason for - the error. This error could wrap several - error messages and is a catch all. - - - notImplemented - 501 - The requested method or - resource is not implemented. - - - serviceUnavailable - 503 - The Database Service is not - available. - - - - The following two instanceFault - examples show errors when the server has erred or - cannot perform the requested operation: - - - Example Fault Response: JSON - - HTTP/1.1 500 Internal Server Error -Content-Length: 120 -Content-Type: application/json; charset=UTF-8 -Date: Tue, 29 Nov 2011 00:33:48 GMT - - - The error code (code) is returned in - the body of the response for convenience. The - message element returns a - human-readable message that is appropriate for display - to the end user. The details element is - optional and may contain information that is useful - for tracking down an error, such as a stack trace. The - details element may or may not be - appropriate for display to an end user, depending on - the role and experience of the end user. - The fault's root element (for example, - instanceFault) may change depending - on the type of error. - The following two - badRequest examples show errors when - the volume size is invalid: - - Example badRequest Fault on Volume Size Errors: - JSON - - HTTP/1.1 400 None -Content-Length: 120 -Content-Type: application/json; charset=UTF-8 -Date: Tue, 29 Nov 2011 00:33:48 GMT - - - The next two examples show itemNotFound - errors: - - Example itemNotFound Fault: JSON - - HTTP/1.1 404 Not Found -Content-Length: 78 -Content-Type: application/json; charset=UTF-8 -Date: Tue, 29 Nov 2011 00:35:24 GMT - - -
- Synchronous Versus Asynchronous - Faults<?sbr?> - Synchronous faults occur at - request time. When a synchronous fault occurs, the - fault contains an HTTP error response code, a - human readable message, and optional details about - the error. The following Database API calls are - synchronous and may produce synchronous - faults: - - List Users - - - List Instances - - - List Instance Details by ID - - - List Databases - - - Enable Root User - - - List Root-Enabled Status - - - List Flavors - - - List Versions - - - List Version Details - - - Asynchronous faults occur - in the background while an instance, database, or - user is being built or an instance is executing an - action. When an asynchronous fault occurs, the - system places the instance, database, or user in - an ERROR state and embeds the fault in the - offending instance, database, or user. When an - asynchronous fault occurs, the fault contains an - HTTP error response code, a human readable - message, and optional details about the error. The - following Database API calls are asynchronous and - may produce asynchronous faults: - - Create Instance - - - Delete Instance - - - Create Database - - - Delete Database - - - Create User - - - Delete User - - - Resize Volume - - - Resize Instance - - - Restart Instance - - - - Note that an asynchronous operation, if - it fails, may not give the user an error, - and the operation can error out without a - failure notification. - -
-
-
- Database Instance Status - When making an API call to - create, list, or delete database instance(s), the - following database instance status values are - possible: - - - BUILD – The database instance is being - provisioned. - - - REBOOT – The database instance is - rebooting. - - - ACTIVE – The database instance is - online and available to take requests. - - - BLOCKED – The database instance is - unresponsive at the moment. - - - RESIZE – The database instance is - being resized at the moment. - - - SHUTDOWN – The database instance is - terminating services. Also, SHUTDOWN is - returned if for any reason the MySQL instance - is shut down but not the actual server. - - If MySQL has crashed (causing the - SHUTDOWN status), please call support for - assistance. - - - - ERROR – The last operation for the - database instance failed due to an - error. - - -
- - - - API Operations - - Do not use trailing slashes (/) at the end of calls - to API operations, since this may cause the call to - fail. For example, do not use &GET; /instances/detail/ - (with the trailing slash at the end). Rather, use - &GET; /instances/detail instead. - - -
- API Versions - This section describes the versions that are - supported for the Cloud Databases API. - - - - - - - - - -
- -
- Database Instances - This section describes the operations that are - supported for database instances. - - - - - - - - - - - - - - - -
- -
- Database Instance Actions - This section describes the actions that are - supported for database instances. - - - - - - - -
- -
- Databases - This section describes the operations that are - supported for databases. - - - - - - - - - -
- -
- Users - This section describes the operations that are - supported for managing database users. - In this section, "user has access to a database" - means that the user has full create, read, update, and - delete access to the given database. In other words, - on a cloud database instance, a user named USER and a - database named DATABASE exist, and within MySQL, a - GRANT ALL ON DATABASE.* TO USER has been issued on the - instance. - - There is a bug in a python library that - development is using that may cause incorrect user - deletions to occur if a period (.) is used in the - user name. In this case, the user name is - truncated to remove the portion of the name from - the period to the end, leaving only the portion - from the beginning up to the period. For example, - for a user named "my.userA", the bug would - truncate the user name to "my", and if the user - "my" exists, that user will be incorrectly - deleted. To avoid the problem, do not use periods - in user names. - - - - - - - - - - - - - - - - - - - -
- -
- Flavors - This section describes the operations that are - supported for flavors. - - - - - - - - - -
- - - Glossary - - database - - A MySQL database within a database - instance. - - - - database instance - - A database instance is an isolated MySQL - instance in a single tenant environment on a - shared physical host machine. Also referred to as - instance. - - - - flavor - - A flavor is an available hardware configuration - for a database instance. Each flavor has a unique - combination of memory capacity and priority for - CPU time. - - - - volume - - A volume is user-specified storage that contains - the MySQL data directory. Volumes are - automatically provisioned on shared Internet Small - Computer System Interface (iSCSI) storage area - networks (SAN) that provide for increased - performance, scalability, availability and - manageability. Applications with high I/O demands - are performance optimized and data is protected - through both local and network RAID-10. - Additionally, network RAID provides synchronous - replication of volumes with automatic failover and - load balancing across available storage - clusters. - - - - diff --git a/apidocs/src/images/Choose_CS_Image.png b/apidocs/src/images/Choose_CS_Image.png deleted file mode 100644 index b60a9df8a9..0000000000 Binary files a/apidocs/src/images/Choose_CS_Image.png and /dev/null differ diff --git a/apidocs/src/images/Choose_CS_Image_CCP.png b/apidocs/src/images/Choose_CS_Image_CCP.png deleted file mode 100644 index 2e6f23ebea..0000000000 Binary files a/apidocs/src/images/Choose_CS_Image_CCP.png and /dev/null differ diff --git a/apidocs/src/images/Choose_Image_CCP.png b/apidocs/src/images/Choose_Image_CCP.png deleted file mode 100644 index 14a555722b..0000000000 Binary files a/apidocs/src/images/Choose_Image_CCP.png and /dev/null differ diff --git a/apidocs/src/images/Choose_Image_CCP.tiff b/apidocs/src/images/Choose_Image_CCP.tiff deleted file mode 100644 index 79d5a45faf..0000000000 Binary files a/apidocs/src/images/Choose_Image_CCP.tiff and /dev/null differ diff --git a/apidocs/src/images/Cloud_DB_Infographic-1.png b/apidocs/src/images/Cloud_DB_Infographic-1.png deleted file mode 100644 index 7a00ae001b..0000000000 Binary files a/apidocs/src/images/Cloud_DB_Infographic-1.png and /dev/null differ diff --git a/apidocs/src/images/Cloud_DB_Infographic-1.svg b/apidocs/src/images/Cloud_DB_Infographic-1.svg deleted file mode 100644 index 4a3f125abb..0000000000 --- a/apidocs/src/images/Cloud_DB_Infographic-1.svg +++ /dev/null @@ -1,4533 +0,0 @@ - - - - -]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/apidocs/src/images/Create_CS.png b/apidocs/src/images/Create_CS.png deleted file mode 100644 index 32c291b347..0000000000 Binary files a/apidocs/src/images/Create_CS.png and /dev/null differ diff --git a/apidocs/src/images/phpMyAdmin.png b/apidocs/src/images/phpMyAdmin.png deleted file mode 100644 index 80f909f99f..0000000000 Binary files a/apidocs/src/images/phpMyAdmin.png and /dev/null differ diff --git a/apidocs/src/xsd/common.ent b/apidocs/src/xsd/common.ent deleted file mode 100644 index b8972274d6..0000000000 --- a/apidocs/src/xsd/common.ent +++ /dev/null @@ -1,72 +0,0 @@ - - - - -GET'> -PUT'> -POST'> -DELETE'> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - '> - - - - - - '> - - - - - - '> diff --git a/apidocs/src/xsd/dbaas.wadl b/apidocs/src/xsd/dbaas.wadl deleted file mode 100644 index 894ce2e701..0000000000 --- a/apidocs/src/xsd/dbaas.wadl +++ /dev/null @@ -1,1592 +0,0 @@ - - - %common; - - -]> - - - - - - - - - - - - - - - The account ID of the owner of the specified - instance. - - - - - - - - The instance ID for the specified - database instance. - - - - - - - - - - - - - - The name for the specified - database. - - - - - - - - - - - The name for the specified - user. - - - - - - - - - The name for the specified - database. - - - - - - - - - - - - - - - - - - The flavor ID for the specified - flavor. - - - - - - - - - - - - - Returns detailed information about - the specified version of the API. - This operation returns detailed information about - the specified version of the API. - - - - - The - following example shows the List Version - Details requests: - - - - - - - - - The - following example shows the List Version - Details responses: - - - - - &commonFaults; &getFaults; - - - - Lists information about all - versions of the API. - This operation lists information about all versions - of the API. - - - - - The - following example shows the List Versions - requests: - - - - - - - - The - following example shows the List Versions - responses: - - - - - &commonFaults; &getFaults; - - - - - Creates a new database - instance. - This operation asynchronously provisions a new - database instance. This call requires the user to - specify a flavor and a - volume size. The service - then provisions the instance with the requested flavor - and sets up a volume of the specified size, which is - the storage for the database instance. - Notes - - You can create only one database - instance per POST - request. - - - You can create a database instance with - one or more databases, and users - associated to those databases. - - - The default binding for the MySQL - instance is port 3306. - - - The following table lists the required and optional - attributes for Create Instance: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Required and Optional Attributes for Create - Instance
Applies ToNameDescriptionRequired
InstanceflavorRefReference (href) to a - flavor as specified in the response - from the List Flavors API call. This - is the actual URI as specified by the - href field in the link. Refer to the - List Flavors response examples that - follow for an example of the - flavorRef. - Rather than the flavor URI, - you can also pass the flavor id - (integer) as the value for - flavorRef. - Refer to for details.Yes
(volume) sizeSpecifies the volume size in - gigabytes (GB). The value specified must - be between 1 and 50.Yes
nameName of the instance to - create. The length of the name is limited - to 255 characters and any characters are - permitted.No
DatabasenameSpecifies - database names - for creating databases on instance - creation. Refer to for the required json format.No
character_setSet of symbols and encodings. - The default character set is - utf8.No
collateSet of rules for comparing - characters in a character set. The default - value for collate is - utf8_general_ci.No
UsernameSpecifies user name for the - database on instance creation. Refer to - for the required json format.No
passwordSpecifies password for those - users on instance creation. Refer to for the required json format.No
(database) nameSpecifies names of databases - that those users can access on instance - creation. Refer to for the required json format.No
- Refer to - for a list of possible database instance statuses that - may be returned. - - - - - The - following example shows the Create Database - Instance requests and responses: - - - - - - - - - - - For - convenience, notice in the response examples - above that resources contain links to - themselves. This allows a client to easily - obtain resource URIs rather than to construct - them. There are two kinds of link relations - associated with resources. A self - link contains a versioned - link to the resource. These links should be - used in cases where the link will be followed - immediately. A bookmark link - provides a permanent link to a resource that - is appropriate for long term storage. - - - &commonFaults; &getFaults; - - - - Deletes the specified database - instance. - This operation deletes the specified database - instance, including any associated data. - Refer to - for a list of possible database instance statuses that - may be returned. - This operation is not allowed when the - instance status is - BUILD. - - - - - The - following example shows the Delete Database - Instance requests: - - - - - &commonFaults; - - - The - following example shows the Delete Database - Instance responses: - - - - &getFaults; - - - - Lists the status and information - for all database instances. - This operation lists the status and information for - all database instances. - Refer to - for a list of possible database instance statuses that - may be returned. - - - - - The - following example shows the List All Database - Instances Detail requests: - - - - - - - - The - following example shows the List All Database - Instances responses: - - - - - &commonFaults; &getFaults; - - - - - Lists status and details for a - specified database instance. - This operation lists the status and details of the - specified database instance. - This operation lists the volume size in gigabytes - (GB) and the approximate GB used. - After instance creation, the used - size of your volume will be greater than 0. This - is expected and due to the automatic creation of - non-empty transaction logs for mysql optimization. - The used attribute is - not returned in the - response when the status for the instance is - BUILD, REBOOT, RESIZE, or ERROR. - - Refer to - for a list of possible database instance statuses that - may be returned. - The list operations return a DNS-resolvable hostname - associated with the database instance instead of an IP - address. Since the hostname always resolves to the - correct IP address of the database instance, this - relieves the user from the task of maintaining the - mapping. Note that although the IP address may likely - change on resizing, migrating, and so forth, the - hostname always resolves to the correct database - instance. - - - - - The - following example shows the List Database - Instance Status and Details requests: - - - - - - - - The - following example shows the List Database - Instance Status and Details responses: - - - - - &commonFaults; &getFaults; - - - - - Restart the database service on the - instance. - The restart operation restarts only the MySQL - instance. Restarting MySQL erases any dynamic - configuration settings that you have made within - MySQL. - The MySQL service is unavailable until the - instance restarts. - This operation returns a 202 Accepted - response. - - - - - The - following example shows the Restart Instance - requests: - - - - - - - - - The - following example shows the Restart Instance - responses: - - - - &commonFaults; &getFaults; &postPutFaults; - - - - Resize the memory of the - instance. - This operation changes the memory size of the - instance, assuming a valid flavorRef is provided. - Restarts MySQL in the process. - - - - - The - following example shows the Resize Instance - requests: - - - - - - - - - The - following example shows the Resize Instance - responses: - - - - &commonFaults; &getFaults; &postPutFaults; - - - - Resize the - volume attached to the - Instance. - This operation supports resizing the attached volume - for an instance. It supports only increasing the - volume size and does not support decreasing the size. - The volume size is in gigabytes (GB) and must be an - integer. - You cannot increase the volume to a size - larger than the API volume size limit - specifies. - This operation returns a 202 Accepted - response. - - - - - The - following example shows the Resize Instance - Volume requests: - - - - - - - - - The - following example shows the Resize Instance - Volume responses: - - - - &commonFaults; &getFaults; &postPutFaults; - - - - - Creates a new - database within the - specified instance. - This operation creates a new database within the - specified instance. - The name of the database is a required - attribute. - The following additional attributes can be specified - for each database: collate and - character_set. - - - - - - - - - - - - - - - - - - - - - - - - - - -
Required and Optional Attributes for Create - Database
NameDescriptionRequired
nameSpecifies the database name - for creating the database. Refer to the - request examples for the required json - format.Yes
character_setSet of symbols and encodings. - The default character set is - utf8.No
collateSet of rules for comparing - characters in a character set. The default - value for collate is - utf8_general_ci.No
- See the MySQL documentation for information about - supported character sets and collations at http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html. - The following database names are reserved and - cannot be used for creating databases: lost+found, - information_schema, and mysql. - Refer to the following tables for information about - characters that are valid/invalid for creating - database names. - - - - - - - - - - - - - - - - - - - - - - -
Valid Characters That Can Be Used in a - Database Name
Character
Letters (upper and lower cases - allowed)
Numbers
'@', '?', '#', and spaces are allowed, but - not at the - beginning and end of the database - name
'_' is allowed anywhere in the database - name
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Characters That Cannot - Be Used in a Database Name
Character
Single quotes
Double quotes
Back quotes
Semicolons
Commas
Backslashes
Forward slashes
- - - - - - - - - - - - - - -
Length Restrictions for Database - Name
RestrictionValue
Database-name maximum length64
- - - - - The - following example shows the Create Database - requests: - - - - - - - - - The - following example shows the Create Database - responses: - - - - &commonFaults; &getFaults; - - - - - Lists databases for the specified - instance. - This operation lists the databases for the specified - instance. - This operation returns only the user-defined - databases, not the system databases. The system - databases (mysql, information_schema, lost+found) - can only be viewed by a database - administrator. - - - - - The - following example shows the List Databases for - Instance requests: - - - - - - - The - following example shows the - paginated List - Databases for Instance requests: - - - - - - - - The - following example shows the List Databases for - Instance responses: - - - - - - - - The - following example shows the - paginated List - Databases for Instance responses: - - - - - &commonFaults; &getFaults; - - - - Deletes the specified - database. - This operation deletes the requested database within - the specified database instance. Note that all data - associated with the database is also deleted. - - - - - The - following example shows the Delete Database - requests: - - - - - - - - The - following example shows the Delete Database - responses: - - - - &commonFaults; &getFaults; - - - - - Creates a user for the specified - database instance. - This operation asynchronously provisions a new user - for the specified database instance based on the - configuration defined in the request object. Once the - request is validated and progress has started on the - provisioning process, a 202 Accepted response object - is returned. - Writer: please add the following note back into - the doc once the List User Details call is added back - into the API: Using the identifier, the caller can - check on the progress of the operation by performing a - GET on users/name (for more details on this operation - see the "List User Details" section of this - document). - If the corresponding request cannot be fulfilled due - to insufficient or invalid data, an HTTP 400 "Bad - Request" error response is returned with information - regarding the nature of the failure. Failures in the - validation process are non-recoverable and require the - caller to correct the cause of the failure and POST - the request again. - The following table lists the required attributes - for Create User. Refer to the request examples for the - required json format: - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Required Attributes for Create User
Applies ToNameDescriptionRequired
UsernameName of the user for the - database.Yes
passwordUser password for database - access.Yes
(database) nameName of the database - that the user can access. One or more - database names must be - specified.No
- Notes - - A user is granted all privileges on the - specified databases. - - - The following user name is reserved and - cannot be used for creating users: - root. - - - Refer to the following tables for information about - characters that are valid/invalid for creating - database names, user names, and passwords. - - - - - - - - - - - - - - - - - - - - - - -
Valid Characters That Can Be Used in a - Database Name, User Name, and Password
Character
Letters (upper and lower cases - allowed)
Numbers
'@', '?', '#', and spaces are allowed, but - not at the - beginning and end of the database name, - user name, and password
"_" is allowed anywhere in the database - name, user name, and password
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Characters That Cannot - Be Used in a Database Name, User Name, and - Password
Character
Single quotes
Double quotes
Back quotes
Semicolons
Commas
Backslashes
Forward slashes
Spaces at the front or end of the user - name or password
- - - - - - - - - - - - - - - - - - - - - - -
Length Restrictions for Database Name, User - Name, and Password
RestrictionValue
Database name maximum length64
User name maximum length16
Password maximum lengthunlimited (no restrictions)
- - - - - The - following example shows the Create User - requests: - - - - - - - - - The - following example shows the Create User - responses: - - - - &commonFaults; &getFaults; - - - - - Lists the users in the specified - database instance. - This operation lists the users in the specified - database instance, along with the associated databases - for that user. - This operation does not return the system - users (database administrators that administer the - health of the database). Also, this operation - returns the "root" user only if "root" user has - been enabled. - The following notes apply to MySQL users: - - - User names can be up to 16 characters - long. - - - When you create accounts with INSERT, you - must use FLUSH PRIVILEGES to tell the server - to reload the grant tables. - - - For additional information, refer to: http://dev.mysql.com/doc/refman/5.1/en/user-account-management.html - - - - - - - The - following example shows the List Users in - Database Instance requests: - - - - - - - The - following example shows the - paginated List Users - in Database Instance requests: - - - - - - - - The - following examples show the List Users in - Database Instance responses: - - - - - - - - The - following example shows the - paginated List Users - in Database Instance responses: - - - - - - &commonFaults; &getFaults; - - - - Changes the MySQL password of one - or more users. - This operation changes the MySQL password of one or - more users. - For information about choosing a valid - password, please refer to for details. - - - - - The - following example shows the Change User(s) - Password requests: - - - - - - - - - - The - following examples show the Change User(s) - Password responses: - - - - &commonFaults; &getFaults; - - - - - Deletes the user identified by - {name} for the specified database instance. - This operation deletes the specified user for the - specified database instance. - There is a bug in a python library that - development is using that may cause incorrect user - deletions to occur if a period (.) is used in the - user name. In this case, the user name is - truncated to remove the portion of the name from - the period to the end, leaving only the portion - from the beginning up to the period. For example, - for a user named "my.userA", the bug would - truncate the user name to "my", and if the user - "my" exists, that user will be incorrectly - deleted. To avoid the problem, do not use periods - in user names. - - - - - The - following example shows the Delete User - requests: - - - - - - - - The - following example shows the Delete User - responses: - - - - &commonFaults; &getFaults; - - - - Lists the specified user's name and - a list of databases that the user can access. - This operation lists the specified user's name and a - list of databases that the user can access. - - - - - The - following example shows the List User - requests: - - - - - - - - The - following examples show the List User - responses: - - - - - &commonFaults; &getFaults; - - - - Shows a list of all databases a - user has access to. - This operation shows a list of all databases a user - has access to. - - - - - The - following example shows the List User Access - requests: - - - - - - - - The - following example shows the List User Access - responses: - - - - - &commonFaults; &getFaults; - - - - Grant access for the specified user - to one or more databases for the specified - instance. - This operation grants access for the specified user - to one or more databases for the specified instance. - The user is granted ALL privileges on the database. - Refer to the information at the beginning of for more details on - access. - - - - - The - following example shows the Grant User Access - requests: - - - - - - - - - The - following example shows the Grant User Access - responses: - - - - &commonFaults; &getFaults; - - - - Remove access to the specified - database for the specified user. - This operation removes access to the specified - database for the specified user. - - - - - The - following example shows the Revoke User Access - requests: - - - - - - - - The - following example shows the Revoke User Access - responses: - - - - &commonFaults; &getFaults; - - - - - Enables the root user for the - specified database instance and returns the root - password. - This operation enables login from any host for the - root user and provides the user with a generated root - password. - Changes you make as a root user may cause - detrimental effects to the database instance and - unpredictable behavior for API operations. When - you enable the root user, you accept the - possibility that we will not be able to support - your database instance. While enabling root does - not prevent us from a “best effort” approach to - helping you if something goes wrong with your - instance, we cannot ensure that we will be able to - assist you if you change core MySQL settings. - These changes can be (but are not limited to) - turning off binlogs, removing users that we use to - access your instance, and so forth. - - - - - The - following example shows the Enable Root User - requests: - - - - - - - - - The - following example shows the Enable Root User - responses: - - - - - &commonFaults; &getFaults; - - - - Returns true if root user is - enabled for the specified database instance or false - otherwise. - This operation checks an active specified database - instance to see if root access is enabled. It returns - True if root user is enabled for the specified - database instance or False otherwise. - - - - - The - following example shows the Check Root User - Access requests: - - - - - - - - The - following example shows the Check Root User - Access responses: - - - - - &commonFaults; &getFaults; - - - - - Lists information for all available - flavors. - This operation lists information for all available - flavors. - This resource is identical to the flavors found in - the OpenStack Nova API, but without the disk - property. - - - - - The - following example shows the List Flavors - requests: - - - - - - - - The - following example shows the List Flavors - responses: - - - - - &commonFaults; &getFaults; - - - - Lists all flavor information about - the specified flavor ID. - This operation lists all information for the - specified flavor ID with details of the RAM. - This resource is identical to the flavors found in - the OpenStack Nova API, but without the disk - property. - The flavorId parameter should be an integer. - If a floating point value is used for the flavorId - parameter, the decimal portion is truncated and - the integer portion is used as the value of the - flavorId. - Reviewer / Writer: need to - confirm that this behavior is not changed in - subsequent releases, and if it is prevented, remove - the Note above. - - - - - The - following example shows the List Flavor By ID - requests: - - - - - - - - The - following example shows the List Flavor By ID - responses: - - - - - &commonFaults; &getFaults; - diff --git a/apidocs/src/xsd/dbaas.xsd b/apidocs/src/xsd/dbaas.xsd deleted file mode 100644 index 06f05f64b3..0000000000 --- a/apidocs/src/xsd/dbaas.xsd +++ /dev/null @@ -1,615 +0,0 @@ - - - - - - - - DBaaS - - -

- This is the main index XML Schema document - for DBaaS API Schema Types Version 1.0. -

- - - - - - -

A MySQL User.

- - - - - - -

A MySQL User.

- - - - - - -

A Database Instance.

- - - - - - -

Database Instances.

- - - - - - -

Settings such as memory used to create a database instance.

- - - - - - -

A list of flavors.

- - - - - - -

A Database.

- - - - - - -

List of Databases.

- - - - - - -

Restart the Database

- - - - - - -

Resize an Instance

- - - - - - - - - - -

A list of database user names.

- - - - - - - - - - - -

A list of databases.

- - - - - - - -

The name for the user.

- - - - - - -

The password for the user.

- - - - - - -

The status of the user.

- - - - - - - - - - -

A list of database instances.

- - - - - - - - - - - -

A list of optional databases.

- - - - - - -

A list of optional users.

- - - - - - -

The links for the type of instance.

- - - - - - -

The volume attached to the instance.

- - - - - - - -

A unique database instance id.

- - - - - - -

Date/Time the instance was created.

- - - - - - -

Date/Time the instance was last updated.

- - - - - - -

The name for the instance.

- - - - - - -

The flavor reference of the instance.

- - - - - - -

The status of the instance.

- - - - - - -

The hostname attached to the instance.

- - - - - - -

Whether or not root is enabled for the instance.

- - - - - - - - - -

The type of link.

- - - - - - -

The URL.

- - - - - - -

The type of link.

- - - - - - - - - - -

A list of flavors.

- - - - - - - - - - - -

A list of links.

- - - - - - - -

A unique flavor id.

- - - - - - -

The name for the instance.

- - - - - - -

The RAM in megabytes.

- - - - - - - - - - -

A list of links.

- - - - - - - - - - - -

A list of databases.

- - - - - - - - - - -

The Database character set.

- - - - - - -

The name for the instance.

- - - - - - -

The Collation type of the database.

- - - - - - - - - -

Whether or not root is enabled for the given instance.

- - - - - - - - - -

Size of the volume in GBs.

- - - - - - -

Used space on the attached volume in GBs.

- - - - - - - - - -

A unique flavor id.

- - - - - - - - - - -

The volume attached to the instance.

- - - - - - -

New flavorRef to size the instance.

- - - - - - - - - - -

The instance status.

- - - - - - -

Healthy status.

- - - - - - -

Down status.

- - - - - - -

unavailable status.

- - - - - - - - - -

The mysql user status.

- - - - - - -

Enabled status.

- - - - - - - - - - - - - - - - - - - - - - - - - -

- A human readable message that is appropriate for display - to the end user. -

- - - - - - -

- The optional <details> element may contain useful - information for tracking down errors (e.g a stack - trace). This information may or may not be appropriate - for display to an end user. -

- - - - - - - - -

- The HTTP status code associated with the current fault. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- An optional dateTime denoting when an operation should - be retried. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/apidocs/src/xslts/js/shjs/sh_java.js b/apidocs/src/xslts/js/shjs/sh_java.js deleted file mode 100644 index 731fc9f340..0000000000 --- a/apidocs/src/xslts/js/shjs/sh_java.js +++ /dev/null @@ -1,337 +0,0 @@ -if (! this.sh_languages) { - this.sh_languages = {}; -} -sh_languages['java'] = [ - [ - [ - /\b(?:import|package)\b/g, - 'sh_preproc', - -1 - ], - [ - /\/\/\//g, - 'sh_comment', - 1 - ], - [ - /\/\//g, - 'sh_comment', - 7 - ], - [ - /\/\*\*/g, - 'sh_comment', - 8 - ], - [ - /\/\*/g, - 'sh_comment', - 9 - ], - [ - /\b[+-]?(?:(?:0x[A-Fa-f0-9]+)|(?:(?:[\d]*\.)?[\d]+(?:[eE][+-]?[\d]+)?))u?(?:(?:int(?:8|16|32|64))|L)?\b/g, - 'sh_number', - -1 - ], - [ - /"/g, - 'sh_string', - 10 - ], - [ - /'/g, - 'sh_string', - 11 - ], - [ - /(\b(?:class|interface))([ \t]+)([$A-Za-z0-9_]+)/g, - ['sh_keyword', 'sh_normal', 'sh_classname'], - -1 - ], - [ - /\b(?:abstract|assert|break|case|catch|class|const|continue|default|do|else|extends|false|final|finally|for|goto|if|implements|instanceof|interface|native|new|null|private|protected|public|return|static|strictfp|super|switch|synchronized|throw|throws|true|this|transient|try|volatile|while)\b/g, - 'sh_keyword', - -1 - ], - [ - /\b(?:int|byte|boolean|char|long|float|double|short|void)\b/g, - 'sh_type', - -1 - ], - [ - /~|!|%|\^|\*|\(|\)|-|\+|=|\[|\]|\\|:|;|,|\.|\/|\?|&|<|>|\|/g, - 'sh_symbol', - -1 - ], - [ - /\{|\}/g, - 'sh_cbracket', - -1 - ], - [ - /(?:[A-Za-z]|_)[A-Za-z0-9_]*(?=[ \t]*\()/g, - 'sh_function', - -1 - ], - [ - /([A-Za-z](?:[^`~!@#$%&*()_=+{}|;:",<.>\/?'\\[\]\^\-\s]|[_])*)((?:<.*>)?)(\s+(?=[*&]*[A-Za-z][^`~!@#$%&*()_=+{}|;:",<.>\/?'\\[\]\^\-\s]*\s*[`~!@#$%&*()_=+{}|;:",<.>\/?'\\[\]\^\-\[\]]+))/g, - ['sh_usertype', 'sh_usertype', 'sh_normal'], - -1 - ] - ], - [ - [ - /$/g, - null, - -2 - ], - [ - /(?:?)|(?:?)/g, - 'sh_url', - -1 - ], - [ - /<\?xml/g, - 'sh_preproc', - 2, - 1 - ], - [ - //g, - 'sh_keyword', - -1 - ], - [ - /<(?:\/)?[A-Za-z](?:[A-Za-z0-9_:.-]*)/g, - 'sh_keyword', - 6, - 1 - ], - [ - /&(?:[A-Za-z0-9]+);/g, - 'sh_preproc', - -1 - ], - [ - /<(?:\/)?[A-Za-z][A-Za-z0-9]*(?:\/)?>/g, - 'sh_keyword', - -1 - ], - [ - /<(?:\/)?[A-Za-z][A-Za-z0-9]*/g, - 'sh_keyword', - 6, - 1 - ], - [ - /@[A-Za-z]+/g, - 'sh_type', - -1 - ], - [ - /(?:TODO|FIXME|BUG)(?:[:]?)/g, - 'sh_todo', - -1 - ] - ], - [ - [ - /\?>/g, - 'sh_preproc', - -2 - ], - [ - /([^=" \t>]+)([ \t]*)(=?)/g, - ['sh_type', 'sh_normal', 'sh_symbol'], - -1 - ], - [ - /"/g, - 'sh_string', - 3 - ] - ], - [ - [ - /\\(?:\\|")/g, - null, - -1 - ], - [ - /"/g, - 'sh_string', - -2 - ] - ], - [ - [ - />/g, - 'sh_preproc', - -2 - ], - [ - /([^=" \t>]+)([ \t]*)(=?)/g, - ['sh_type', 'sh_normal', 'sh_symbol'], - -1 - ], - [ - /"/g, - 'sh_string', - 3 - ] - ], - [ - [ - /-->/g, - 'sh_comment', - -2 - ], - [ - //g, - 'sh_comment', - -2 - ], - [ - //g, - 'sh_comment', - -2 - ], - [ - / array of links - // - // possible types include: import, include, element, - // attribute, complextype, simpleType - // - // each link contains the following properties: - // name : the name of the link - // href : the link itself - // title : a description of the link - links : new Object(), - - // - // A single link that points to the schema index document. - // - index : null, - - // - // Our initialization function - // - _init : function() { - // - // Load the menu... - // - var controllerDiv = document.getElementById("Controller"); - var mainMenu = this._menuMarkup("mainmenu"); - - for (var linkType in this.links) - { - var subItem = this._menuItemMarkup(mainMenu, linkType, "#", null); - var subMenu = this._menuMarkup (linkType+"_subMenu"); - - var items = this.links[linkType]; - for (var i=0;i Array of sample ids. - // - samples : new Object(), - - // - // An array of code data.. - // - // Code data is defined as an object with the following - // properties: - // - // type: The mimetype of the code...href: The location of the code - // or null if it's inline - // - // id: The id of the pre that contains the code. - // - // The initial object is the source code for the current document. - // - codes : new Array({ - id : "SrcContentCode", - type : "application/xml", - href : (function() { - var ret = location.href; - if (location.hash && (location.hash.length != 0)) - { - ret = ret.replace (location.hash, ""); - } - return ret; - })() - }), - - // - // Sets up the manager, begins the loading process... - // - _init : function() { - // - // Setup an array to hold data items to load, this is used by - // the loadSample method. - // - this._toLoad = new Array(); - - for (var i=0;i -1) && - (ieVersion < 8)) - { - code = trc.util.text.unix2dos (code); - } - - var pre = document.getElementById(codeData.id); - var preNodes = pre.childNodes; - // - // Remove placeholder data... - // - while (preNodes.length != 0) - { - pre.removeChild (preNodes[0]); - } - - // - // Set the correct class type... - // - switch (codeData.type) - { - /* - Javascript mimetypes - */ - case 'application/json': - case 'application/javascript': - case 'application/x-javascript': - case 'application/ecmascript': - case 'text/ecmascript': - case 'text/javascript': - trc.util.dom.setClassName (pre, "sh_javascript"); - break; - /* - Not real mimetypes but this is what we'll use for Java. - */ - case 'application/java': - case 'text/java': - trc.util.dom.setClassName (pre, "sh_java"); - break; - default: - trc.util.dom.setClassName (pre, "sh_xml"); - break; - } - - // - // Add new code... - // - pre.appendChild (document.createTextNode (code)); - }, - - // - // Retrieves source code text - // - _getCodeText : function (codeData /* Info for the code to get*/) - { - var pre = document.getElementById(codeData.id); - pre.normalize(); - // - // Should be a single text node after pre... - // - return pre.firstChild.nodeValue; - }, - - - // - // Normalizes text by ensuring that top, bottom, right indent - // levels are equal for all samples. - // - _normalizeCodeText : function (top, /* integer, top indent in lines */ - bottom, /* integer, bottom indent in lines */ - right /* integer, right indent in spaces */ - ) - { - for (var i=0;i -1) && - (ieVersion < 7)) - { - element.className = name; - } - else - { - element.setAttribute ("class",name); - } - } -}; - -trc.util.text = { - // - // Useful RegExps - // - blank : new RegExp ("^\\s*$"), /* A blank string */ - indent : new RegExp ("^\\s+"), /* Line indent */ - lines : new RegExp ("$","m"), /* All lines */ - linechars : new RegExp ("(\n|\r)"), /* EOL line characters */ - tabs : new RegExp ("\t","g"), /* All tabs */ - - // - // We need this because microsoft browsers before IE 7, cannot - // display pre-formatted text correctly win unix style line - // endings. - // - unix2dos : function(txt /* String */) { - //if already DOS... - if (txt.search(/\r\n/) != -1) - { - return txt; - } - return txt.replace (/\n/g, "\r\n"); - }, - - // - // Useful to normalize text. - // - dos2unix : function(txt /* String */) { - //if already unix... - if (txt.search(/\r\n/) == -1) - { - return txt; - } - - return txt.replace(/\r/g, ""); - }, - - // - // Create a string with a character repeated x times. - // - repString : function (length, /* integer, size of the string to create */ - ch /* string, The character to set the string to */ - ) - { - var ret = new String(); - for (var i=0;idep. - // - _deps : new Object(), - - // - // An array of callback functions, these should be called when all - // dependencies are loaded. - // - _callbacks : new Array(), - - // - // The init function simply calls the YUI loader... - // - _init : function() { - var yuiUtil = this; - - // - // It takes safari a while to load the YUI Loader if it hasn't - // loaded yet keep trying at 1/4 second intervals - // - if (!window.YAHOO) - { - window.setTimeout (function() { - yuiUtil._init(); - }, 250); - return; - } - - // - // Collect requirements... - // - var required = new Array(); - for (var req in this._deps) - { - required.push (req); - } - - // - // Load YUI dependencies... - // - var loader = new YAHOO.util.YUILoader({ - require: required, - loadOptional: true, - filter: "RAW", - onSuccess: function() { - yuiUtil._depsLoaded(); - }, - timeout: 10000, - combine: true - }); - loader.insert(); - }, - - // - // Called after all dependencies have been loaded - // - _depsLoaded : function() { - // - // Dependencies are loaded let everyone know. - // - for (var i=0;i, + */ -pre.sh_sourceCode .sh_function { color: black; font-weight: bold; } /* function calls and declarations */ -pre.sh_sourceCode .sh_cbracket { color: red; } /* block brackets (e.g., {, }) */ -pre.sh_sourceCode .sh_todo { font-weight: bold; background-color: cyan; } /* TODO and FIXME */ - -/* Predefined variables and functions (for instance glsl) */ -pre.sh_sourceCode .sh_predef_var { color: darkblue; } -pre.sh_sourceCode .sh_predef_func { color: darkblue; font-weight: bold; } - -/* for OOP */ -pre.sh_sourceCode .sh_classname { color: teal; } - -/* line numbers (not yet implemented) */ -pre.sh_sourceCode .sh_linenum { color: black; font-family: monospace; } - -/* Internet related */ -pre.sh_sourceCode .sh_url { color: blue; text-decoration: underline; font-family: monospace; } - -/* for ChangeLog and Log files */ -pre.sh_sourceCode .sh_date { color: blue; font-weight: bold; } -pre.sh_sourceCode .sh_time, pre.sh_sourceCode .sh_file { color: darkblue; font-weight: bold; } -pre.sh_sourceCode .sh_ip, pre.sh_sourceCode .sh_name { color: darkgreen; } - -/* for Prolog, Perl... */ -pre.sh_sourceCode .sh_variable { color: darkgreen; } - -/* for LaTeX */ -pre.sh_sourceCode .sh_italics { color: darkgreen; font-style: italic; } -pre.sh_sourceCode .sh_bold { color: darkgreen; font-weight: bold; } -pre.sh_sourceCode .sh_underline { color: darkgreen; text-decoration: underline; } -pre.sh_sourceCode .sh_fixed { color: green; font-family: monospace; } -pre.sh_sourceCode .sh_argument { color: darkgreen; } -pre.sh_sourceCode .sh_optionalargument { color: purple; } -pre.sh_sourceCode .sh_math { color: orange; } -pre.sh_sourceCode .sh_bibtex { color: blue; } - -/* for diffs */ -pre.sh_sourceCode .sh_oldfile { color: orange; } -pre.sh_sourceCode .sh_newfile { color: darkgreen; } -pre.sh_sourceCode .sh_difflines { color: blue; } - -/* for css */ -pre.sh_sourceCode .sh_selector { color: purple; } -pre.sh_sourceCode .sh_property { color: blue; } -pre.sh_sourceCode .sh_value { color: darkgreen; font-style: italic; } - -/* other */ -pre.sh_sourceCode .sh_section { color: black; font-weight: bold; } -pre.sh_sourceCode .sh_paren { color: red; } -pre.sh_sourceCode .sh_attribute { color: darkgreen; } diff --git a/apidocs/src/xslts/style/shjs/sh_whitengrey.css b/apidocs/src/xslts/style/shjs/sh_whitengrey.css deleted file mode 100644 index 41df0e2c6d..0000000000 --- a/apidocs/src/xslts/style/shjs/sh_whitengrey.css +++ /dev/null @@ -1,139 +0,0 @@ -pre.sh_sourceCode { - background-color: #ffffff; - color: #696969; - font-weight: normal; - font-style: normal; -} - -pre.sh_sourceCode .sh_keyword { - color: #696969; - font-weight: bold; - font-style: normal; -} - -pre.sh_sourceCode .sh_type { - color: #696969; - font-weight: normal; - font-style: normal; -} - -pre.sh_sourceCode .sh_string { - color: #008800; - font-weight: normal; - font-style: normal; -} - -pre.sh_sourceCode .sh_regexp { - color: #008800; - font-weight: normal; - font-style: normal; -} - -pre.sh_sourceCode .sh_specialchar { - color: #008800; - font-weight: normal; - font-style: normal; -} - -pre.sh_sourceCode .sh_comment { - color: #1326a2; - font-weight: normal; - font-style: italic; -} - -pre.sh_sourceCode .sh_number { - color: #bb00ff; - font-weight: normal; - font-style: normal; -} - -pre.sh_sourceCode .sh_preproc { - color: #470000; - font-weight: normal; - font-style: normal; -} - -pre.sh_sourceCode .sh_function { - color: #000000; - font-weight: normal; - font-style: normal; -} - -pre.sh_sourceCode .sh_url { - color: #008800; - font-weight: normal; - font-style: normal; -} - -pre.sh_sourceCode .sh_date { - color: #696969; - font-weight: bold; - font-style: normal; -} - -pre.sh_sourceCode .sh_time { - color: #696969; - font-weight: bold; - font-style: normal; -} - -pre.sh_sourceCode .sh_file { - color: #696969; - font-weight: bold; - font-style: normal; -} - -pre.sh_sourceCode .sh_ip { - color: #008800; - font-weight: normal; - font-style: normal; -} - -pre.sh_sourceCode .sh_name { - color: #008800; - font-weight: normal; - font-style: normal; -} - -pre.sh_sourceCode .sh_variable { - color: #696969; - font-weight: bold; - font-style: normal; -} - -pre.sh_sourceCode .sh_oldfile { - color: #008800; - font-weight: normal; - font-style: normal; -} - -pre.sh_sourceCode .sh_newfile { - color: #008800; - font-weight: normal; - font-style: normal; -} - -pre.sh_sourceCode .sh_difflines { - color: #696969; - font-weight: bold; - font-style: normal; -} - -pre.sh_sourceCode .sh_selector { - color: #696969; - font-weight: bold; - font-style: normal; -} - -pre.sh_sourceCode .sh_property { - color: #696969; - font-weight: bold; - font-style: normal; -} - -pre.sh_sourceCode .sh_value { - color: #008800; - font-weight: normal; - font-style: normal; -} - diff --git a/apidocs/src/xslts/xslt/.htaccess b/apidocs/src/xslts/xslt/.htaccess deleted file mode 100644 index 2806956cc6..0000000000 --- a/apidocs/src/xslts/xslt/.htaccess +++ /dev/null @@ -1,5 +0,0 @@ -AddType application/xml wadl -AddType application/xml xsd -AddType application/xml xslt - - diff --git a/apidocs/src/xslts/xslt/schema.xslt b/apidocs/src/xslts/xslt/schema.xslt deleted file mode 100644 index e8ef717518..0000000000 --- a/apidocs/src/xslts/xslt/schema.xslt +++ /dev/null @@ -1,1330 +0,0 @@ - - - - - - - - - - - XML Schema Documentation - application/xhtml+xml - http://www.w3.org/2001/XMLSchema - http://web4.w3.org/TR/2001/REC-xmlschema-2-20010502/# - - " - ' - - - - - - - - - - - - - - - - - - - - element_ - attrib_ - attgrp_ - grp_ - type_ - - - - http://yui.yahooapis.com/2.7.0/build/ - - - - - - - - - - - - - - - - - stylesheet - text/css - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - <xslt:value-of select="xsd:annotation/xsd:appinfo/xsdxt:title"/> - - - <xslt:value-of select="$defaultTitle"/> - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
-
- 
Loading...
-
-
-
- - - -

- - -

- - - - - - - - - - - - - -
- - - - - - - - - -

Namespaces

- - - -
-

- Your browser does not seem to have support for - namespace nodes in XPath. If you're a Firefox - user, please consider voting to get this issue - resolved: - - https://bugzilla.mozilla.org/show_bug.cgi?id=94270 - -

-
- - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - - - - - trc.schema.controller.links[' - - ']=[ - - - - - - - - - - - - - - - - - - - - - - - - - - , - - - ]; - - - - - - trc.schema.controller.index = - - - - - - index - - - Index Schema Document - - - ; - - - - - - - trc.schema.controller.links[' - - ']=[ - - - - # - - - - - - - - See definition of - - - - - , - - - ]; - - - - - - - - { href : - - - - - - , name : - - - - - - , title : - - - - - - } - - - - - - - - -

Imports

- - - - - - - - - -
- - -
-
- - - Visit - - -
-
- -
-
-
- - - -

Includes

- - - - - - - - -
-
-
- - - Visit - - -
-
- -
-
-
- - - -

Elements

- - - - - - - - - - - - - - - -
-
- - - trc.schema.sampleManager.showSample( - - - - ); - - - - - - - - - - - - - - - - - - - - -
-
- - - - Sample -
- -
- - - - - - - -
- - - - - - - Loading... - - - - - - -
- - - - - - - -

Complex Types

- - - - - - - - - -

Simple Types

- - - - - - - - - - - - - # - - - - - - - - - - - - - - - - - - -

- -

- - - - - -
- extends: - - - - , - - -
- - -
- restricts: - - - - , - - -
- - - - - - - - - - - - - - - - - SubAttributes - - - Attributes - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - SubDocumentation - - - Documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Sequence - - -
- - - - -
-
-
- -
- - - -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - <?> (Any Element) - - - - - - - - @? (Any Attribute) - - - - - -
- restriction -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
enum values
- - - - - - - - - - - - - - -
-
- - - (id = - - ) - -
- -
- -
- -
- - - - - - - - - - (id = - - ) - - - (fixed) - - - - - - - - - - - - -
- -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - < - - > - - - - - - @ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/etc/tests/localhost.test.conf b/etc/tests/localhost.test.conf index 9eb3965a8c..c834ec58df 100644 --- a/etc/tests/localhost.test.conf +++ b/etc/tests/localhost.test.conf @@ -125,7 +125,7 @@ ], "examples": { - "directory":"apidocs/src/samples", + "directory":"api-ref/source/samples", "normal_user_name":"hub_cap", "normal_user_tenant":"3000", "admin_user_name":"admin", diff --git a/test-requirements.txt b/test-requirements.txt index 6bfce31208..0493aa15ae 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,6 +5,7 @@ hacking<0.11,>=0.10.0 bandit>=1.0.1 # Apache-2.0 sphinx!=1.3b1,<1.3,>=1.2.1 # BSD +os-api-ref>=0.4.0 # Apache-2.0 oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0 reno>=1.8.0 # Apache2 coverage>=3.6 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 4e41769f84..e7feebf214 100644 --- a/tox.ini +++ b/tox.ini @@ -62,6 +62,12 @@ filename=*.py,trove-* commands = openstack-doc-test --check-links {posargs} [testenv:checkbuild] +# NOTE(pmalik) The setting of the install_command in this location +# is only required because currently infra does not actually +# support constraints files for the publishdocs job, and while +# the environment variable UPPER_CONSTRAINTS_FILE is set, there's +# no file there. It can be removed when infra changes this. +install_command = pip install -U {opts} {packages} commands = openstack-doc-test --check-niceness --check-syntax --check-deletions {posargs} openstack-doc-test --check-build {posargs} @@ -69,6 +75,14 @@ commands = [testenv:publishdocs] commands = openstack-doc-test --check-build --publish --force +[testenv:api-ref] +# This environment is called from CI scripts to test and publish +# the API Ref to developer.openstack.org. +commands = + rm -rf api-ref/build + sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html +whitelist_externals = rm + [testenv:releasenotes] commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html diff --git a/trove/tests/examples/client.py b/trove/tests/examples/client.py index f8a56d6ee7..57835e3541 100644 --- a/trove/tests/examples/client.py +++ b/trove/tests/examples/client.py @@ -58,7 +58,7 @@ class SnippetWriter(object): headers.append("Accept: %s" % output_headers['Accept']) print("OUTPUT HEADERS: %s" % output_headers) headers.append("Content-Type: %s" % output_headers['Content-Type']) - self.write_file(user_details, name, "-%s.txt" % content_type, url, + self.write_file(user_details, name, "-%s-http.txt" % content_type, url, method, "request", output='\n'.join(headers)) pretty_body = self.format_body(body, content_type) @@ -82,7 +82,7 @@ class SnippetWriter(object): new_lines = [x[0] for x in lines] joined_lines = '\n'.join(new_lines) - self.write_file(user_details, name, "-%s.txt" % content_type, url, + self.write_file(user_details, name, "-%s-http.txt" % content_type, url, method, "response", output=joined_lines) if body: