1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 01:39:58 -05:00

adding openapi docs

This commit is contained in:
anushah 2020-07-15 09:01:34 +05:30
parent fdf2c0b7a7
commit 83bd922c86
167 changed files with 83644 additions and 0 deletions

20
openapi/docs/Makefile Normal file
View File

@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

4
openapi/docs/build/html/.buildinfo vendored Normal file
View File

@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 68df950f9ac49cd2755e5e3e8b328651
tags: 645f666f9bcd5a90fca523b33c5a78b7

View File

@ -0,0 +1,21 @@
.. VMware Automation SDK for Python documentation master file, created by
sphinx-quickstart on Mon Jul 13 20:10:54 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to VMware Automation SDK for Python's documentation!
============================================================
.. toctree::
:maxdepth: 10
:caption: Contents:
vmc/console/modules
vmc/draas/modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -0,0 +1,9 @@
console
=======
.. toctree::
:maxdepth: 4
setup
test
vmware

View File

@ -0,0 +1,7 @@
setup module
============
.. automodule:: setup
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,18 @@
vmware package
==============
Subpackages
-----------
.. toctree::
:maxdepth: 4
vmware.vmc
Module contents
---------------
.. automodule:: vmware
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,198 @@
vmware.vmc.console.api package
==============================
Submodules
----------
vmware.vmc.console.api.account\_linking\_api module
---------------------------------------------------
.. automodule:: vmware.vmc.console.api.account_linking_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.addons\_api module
-----------------------------------------
.. automodule:: vmware.vmc.console.api.addons_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.clusters\_api module
-------------------------------------------
.. automodule:: vmware.vmc.console.api.clusters_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.config\_storage\_api module
--------------------------------------------------
.. automodule:: vmware.vmc.console.api.config_storage_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.credentials\_api module
----------------------------------------------
.. automodule:: vmware.vmc.console.api.credentials_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.dns\_api module
--------------------------------------
.. automodule:: vmware.vmc.console.api.dns_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.edges\_api module
----------------------------------------
.. automodule:: vmware.vmc.console.api.edges_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.esx\_api module
--------------------------------------
.. automodule:: vmware.vmc.console.api.esx_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.hcx\_api module
--------------------------------------
.. automodule:: vmware.vmc.console.api.hcx_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.locale\_api module
-----------------------------------------
.. automodule:: vmware.vmc.console.api.locale_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.msft\_licensing\_api module
--------------------------------------------------
.. automodule:: vmware.vmc.console.api.msft_licensing_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.network\_api module
------------------------------------------
.. automodule:: vmware.vmc.console.api.network_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.orgs\_api module
---------------------------------------
.. automodule:: vmware.vmc.console.api.orgs_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.publicip\_api module
-------------------------------------------
.. automodule:: vmware.vmc.console.api.publicip_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.reservations\_api module
-----------------------------------------------
.. automodule:: vmware.vmc.console.api.reservations_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.sddc\_api module
---------------------------------------
.. automodule:: vmware.vmc.console.api.sddc_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.sddc\_networks\_api module
-------------------------------------------------
.. automodule:: vmware.vmc.console.api.sddc_networks_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.sddc\_template\_api module
-------------------------------------------------
.. automodule:: vmware.vmc.console.api.sddc_template_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.storage\_api module
------------------------------------------
.. automodule:: vmware.vmc.console.api.storage_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.subscription\_api module
-----------------------------------------------
.. automodule:: vmware.vmc.console.api.subscription_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.task\_api module
---------------------------------------
.. automodule:: vmware.vmc.console.api.task_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.tbrs\_api module
---------------------------------------
.. automodule:: vmware.vmc.console.api.tbrs_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.api.troubleshooting\_api module
--------------------------------------------------
.. automodule:: vmware.vmc.console.api.troubleshooting_api
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: vmware.vmc.console.api
:members:
:undoc-members:
:show-inheritance:

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,55 @@
vmware.vmc.console package
==========================
Subpackages
-----------
.. toctree::
:maxdepth: 4
vmware.vmc.console.api
vmware.vmc.console.models
Submodules
----------
vmware.vmc.console.api\_client module
-------------------------------------
.. automodule:: vmware.vmc.console.api_client
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.configuration module
---------------------------------------
.. automodule:: vmware.vmc.console.configuration
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.exceptions module
------------------------------------
.. automodule:: vmware.vmc.console.exceptions
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.console.rest module
------------------------------
.. automodule:: vmware.vmc.console.rest
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: vmware.vmc.console
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,18 @@
vmware.vmc package
==================
Subpackages
-----------
.. toctree::
:maxdepth: 4
vmware.vmc.console
Module contents
---------------
.. automodule:: vmware.vmc
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,9 @@
draas
=====
.. toctree::
:maxdepth: 4
setup
test
vmware

View File

@ -0,0 +1,7 @@
setup module
============
.. automodule:: setup
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
vmware package
==============
Subpackages
-----------
.. toctree::
:maxdepth: 4
vmware.vmc
vmware.vmc_draas
Module contents
---------------
.. automodule:: vmware
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,30 @@
vmware.vmc.draas.api package
============================
Submodules
----------
vmware.vmc.draas.api.site\_recovery\_api module
-----------------------------------------------
.. automodule:: vmware.vmc.draas.api.site_recovery_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.api.task\_api module
-------------------------------------
.. automodule:: vmware.vmc.draas.api.task_api
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: vmware.vmc.draas.api
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,134 @@
vmware.vmc.draas.models package
===============================
Submodules
----------
vmware.vmc.draas.models.abstract\_entity module
-----------------------------------------------
.. automodule:: vmware.vmc.draas.models.abstract_entity
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.models.activate\_site\_recovery\_config module
---------------------------------------------------------------
.. automodule:: vmware.vmc.draas.models.activate_site_recovery_config
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.models.error\_response module
----------------------------------------------
.. automodule:: vmware.vmc.draas.models.error_response
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.models.provision\_srm\_config module
-----------------------------------------------------
.. automodule:: vmware.vmc.draas.models.provision_srm_config
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.models.replica\_disk module
--------------------------------------------
.. automodule:: vmware.vmc.draas.models.replica_disk
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.models.replica\_disk\_collection module
--------------------------------------------------------
.. automodule:: vmware.vmc.draas.models.replica_disk_collection
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.models.site\_recovery module
---------------------------------------------
.. automodule:: vmware.vmc.draas.models.site_recovery
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.models.site\_recovery\_all\_of module
------------------------------------------------------
.. automodule:: vmware.vmc.draas.models.site_recovery_all_of
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.models.site\_recovery\_node module
---------------------------------------------------
.. automodule:: vmware.vmc.draas.models.site_recovery_node
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.models.site\_recovery\_node\_all\_of module
------------------------------------------------------------
.. automodule:: vmware.vmc.draas.models.site_recovery_node_all_of
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.models.site\_recovery\_node\_version module
------------------------------------------------------------
.. automodule:: vmware.vmc.draas.models.site_recovery_node_version
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.models.site\_recovery\_versions module
-------------------------------------------------------
.. automodule:: vmware.vmc.draas.models.site_recovery_versions
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.models.task module
-----------------------------------
.. automodule:: vmware.vmc.draas.models.task
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.models.task\_all\_of module
--------------------------------------------
.. automodule:: vmware.vmc.draas.models.task_all_of
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.models.task\_progress\_phase module
----------------------------------------------------
.. automodule:: vmware.vmc.draas.models.task_progress_phase
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: vmware.vmc.draas.models
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,55 @@
vmware.vmc.draas package
========================
Subpackages
-----------
.. toctree::
:maxdepth: 4
vmware.vmc.draas.api
vmware.vmc.draas.models
Submodules
----------
vmware.vmc.draas.api\_client module
-----------------------------------
.. automodule:: vmware.vmc.draas.api_client
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.configuration module
-------------------------------------
.. automodule:: vmware.vmc.draas.configuration
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.exceptions module
----------------------------------
.. automodule:: vmware.vmc.draas.exceptions
:members:
:undoc-members:
:show-inheritance:
vmware.vmc.draas.rest module
----------------------------
.. automodule:: vmware.vmc.draas.rest
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: vmware.vmc.draas
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,18 @@
vmware.vmc package
==================
Subpackages
-----------
.. toctree::
:maxdepth: 4
vmware.vmc.draas
Module contents
---------------
.. automodule:: vmware.vmc
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,30 @@
vmware.vmc\_draas.api package
=============================
Submodules
----------
vmware.vmc\_draas.api.site\_recovery\_api module
------------------------------------------------
.. automodule:: vmware.vmc_draas.api.site_recovery_api
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.api.task\_api module
--------------------------------------
.. automodule:: vmware.vmc_draas.api.task_api
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: vmware.vmc_draas.api
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,134 @@
vmware.vmc\_draas.models package
================================
Submodules
----------
vmware.vmc\_draas.models.abstract\_entity module
------------------------------------------------
.. automodule:: vmware.vmc_draas.models.abstract_entity
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.models.activate\_site\_recovery\_config module
----------------------------------------------------------------
.. automodule:: vmware.vmc_draas.models.activate_site_recovery_config
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.models.error\_response module
-----------------------------------------------
.. automodule:: vmware.vmc_draas.models.error_response
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.models.provision\_srm\_config module
------------------------------------------------------
.. automodule:: vmware.vmc_draas.models.provision_srm_config
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.models.replica\_disk module
---------------------------------------------
.. automodule:: vmware.vmc_draas.models.replica_disk
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.models.replica\_disk\_collection module
---------------------------------------------------------
.. automodule:: vmware.vmc_draas.models.replica_disk_collection
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.models.site\_recovery module
----------------------------------------------
.. automodule:: vmware.vmc_draas.models.site_recovery
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.models.site\_recovery\_all\_of module
-------------------------------------------------------
.. automodule:: vmware.vmc_draas.models.site_recovery_all_of
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.models.site\_recovery\_node module
----------------------------------------------------
.. automodule:: vmware.vmc_draas.models.site_recovery_node
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.models.site\_recovery\_node\_all\_of module
-------------------------------------------------------------
.. automodule:: vmware.vmc_draas.models.site_recovery_node_all_of
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.models.site\_recovery\_node\_version module
-------------------------------------------------------------
.. automodule:: vmware.vmc_draas.models.site_recovery_node_version
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.models.site\_recovery\_versions module
--------------------------------------------------------
.. automodule:: vmware.vmc_draas.models.site_recovery_versions
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.models.task module
------------------------------------
.. automodule:: vmware.vmc_draas.models.task
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.models.task\_all\_of module
---------------------------------------------
.. automodule:: vmware.vmc_draas.models.task_all_of
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.models.task\_progress\_phase module
-----------------------------------------------------
.. automodule:: vmware.vmc_draas.models.task_progress_phase
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: vmware.vmc_draas.models
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,55 @@
vmware.vmc\_draas package
=========================
Subpackages
-----------
.. toctree::
:maxdepth: 4
vmware.vmc_draas.api
vmware.vmc_draas.models
Submodules
----------
vmware.vmc\_draas.api\_client module
------------------------------------
.. automodule:: vmware.vmc_draas.api_client
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.configuration module
--------------------------------------
.. automodule:: vmware.vmc_draas.configuration
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.exceptions module
-----------------------------------
.. automodule:: vmware.vmc_draas.exceptions
:members:
:undoc-members:
:show-inheritance:
vmware.vmc\_draas.rest module
-----------------------------
.. automodule:: vmware.vmc_draas.rest
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: vmware.vmc_draas
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,855 @@
/*
* basic.css
* ~~~~~~~~~
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
}
div.section::after {
display: block;
content: '';
clear: left;
}
/* -- relbar ---------------------------------------------------------------- */
div.related {
width: 100%;
font-size: 90%;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
}
div.related li.right {
float: right;
margin-right: 5px;
}
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
}
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
word-wrap: break-word;
overflow-wrap : break-word;
}
div.sphinxsidebar ul {
list-style: none;
}
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar form {
margin-top: 10px;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
div.sphinxsidebar #searchbox form.search {
overflow: hidden;
}
div.sphinxsidebar #searchbox input[type="text"] {
float: left;
width: 80%;
padding: 0.25em;
box-sizing: border-box;
}
div.sphinxsidebar #searchbox input[type="submit"] {
float: left;
width: 20%;
border-left: none;
padding: 0.25em;
box-sizing: border-box;
}
img {
border: 0;
max-width: 100%;
}
/* -- search page ----------------------------------------------------------- */
ul.search {
margin: 10px 0 0 20px;
padding: 0;
}
ul.search li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
}
ul.search li a {
font-weight: bold;
}
ul.search li div.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
margin-left: auto;
margin-right: auto;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
/* -- general index --------------------------------------------------------- */
table.indextable {
width: 100%;
}
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable ul {
margin-top: 0;
margin-bottom: 0;
list-style-type: none;
}
table.indextable > tbody > tr > td > ul {
padding-left: 0em;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
div.modindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
div.genindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
/* -- domain module index --------------------------------------------------- */
table.modindextable td {
padding: 2px;
border-collapse: collapse;
}
/* -- general body styles --------------------------------------------------- */
div.body {
min-width: 450px;
max-width: 800px;
}
div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
-webkit-hyphens: auto;
hyphens: auto;
}
a.headerlink {
visibility: hidden;
}
a.brackets:before,
span.brackets > a:before{
content: "[";
}
a.brackets:after,
span.brackets > a:after {
content: "]";
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink,
caption:hover > a.headerlink,
p.caption:hover > a.headerlink,
div.code-block-caption:hover > a.headerlink {
visibility: visible;
}
div.body p.caption {
text-align: inherit;
}
div.body td {
text-align: left;
}
.first {
margin-top: 0 !important;
}
p.rubric {
margin-top: 30px;
font-weight: bold;
}
img.align-left, .figure.align-left, object.align-left {
clear: left;
float: left;
margin-right: 1em;
}
img.align-right, .figure.align-right, object.align-right {
clear: right;
float: right;
margin-left: 1em;
}
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
img.align-default, .figure.align-default {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left;
}
.align-center {
text-align: center;
}
.align-default {
text-align: center;
}
.align-right {
text-align: right;
}
/* -- sidebars -------------------------------------------------------------- */
div.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px;
background-color: #ffe;
width: 40%;
float: right;
clear: right;
overflow-x: auto;
}
p.sidebar-title {
font-weight: bold;
}
div.admonition, div.topic, blockquote {
clear: left;
}
/* -- topics ---------------------------------------------------------------- */
div.topic {
border: 1px solid #ccc;
padding: 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
/* -- content of sidebars/topics/admonitions -------------------------------- */
div.sidebar > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
}
div.sidebar::after,
div.topic::after,
div.admonition::after,
blockquote::after {
display: block;
content: '';
clear: both;
}
/* -- tables ---------------------------------------------------------------- */
table.docutils {
margin-top: 10px;
margin-bottom: 10px;
border: 0;
border-collapse: collapse;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
table.align-default {
margin-left: auto;
margin-right: auto;
}
table caption span.caption-number {
font-style: italic;
}
table caption span.caption-text {
}
table.docutils td, table.docutils th {
padding: 1px 8px 1px 5px;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
table.footnote td, table.footnote th {
border: 0 !important;
}
th {
text-align: left;
padding-right: 5px;
}
table.citation {
border-left: solid 1px gray;
margin-left: 1px;
}
table.citation td {
border-bottom: none;
}
th > :first-child,
td > :first-child {
margin-top: 0px;
}
th > :last-child,
td > :last-child {
margin-bottom: 0px;
}
/* -- figures --------------------------------------------------------------- */
div.figure {
margin: 0.5em;
padding: 0.5em;
}
div.figure p.caption {
padding: 0.3em;
}
div.figure p.caption span.caption-number {
font-style: italic;
}
div.figure p.caption span.caption-text {
}
/* -- field list styles ----------------------------------------------------- */
table.field-list td, table.field-list th {
border: 0 !important;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}
/* -- hlist styles ---------------------------------------------------------- */
table.hlist {
margin: 1em 0;
}
table.hlist td {
vertical-align: top;
}
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
list-style: decimal;
}
ol.loweralpha {
list-style: lower-alpha;
}
ol.upperalpha {
list-style: upper-alpha;
}
ol.lowerroman {
list-style: lower-roman;
}
ol.upperroman {
list-style: upper-roman;
}
:not(li) > ol > li:first-child > :first-child,
:not(li) > ul > li:first-child > :first-child {
margin-top: 0px;
}
:not(li) > ol > li:last-child > :last-child,
:not(li) > ul > li:last-child > :last-child {
margin-bottom: 0px;
}
ol.simple ol p,
ol.simple ul p,
ul.simple ol p,
ul.simple ul p {
margin-top: 0;
}
ol.simple > li:not(:first-child) > p,
ul.simple > li:not(:first-child) > p {
margin-top: 0;
}
ol.simple p,
ul.simple p {
margin-bottom: 0;
}
dl.footnote > dt,
dl.citation > dt {
float: left;
margin-right: 0.5em;
}
dl.footnote > dd,
dl.citation > dd {
margin-bottom: 0em;
}
dl.footnote > dd:after,
dl.citation > dd:after {
content: "";
clear: both;
}
dl.field-list {
display: grid;
grid-template-columns: fit-content(30%) auto;
}
dl.field-list > dt {
font-weight: bold;
word-break: break-word;
padding-left: 0.5em;
padding-right: 5px;
}
dl.field-list > dt:after {
content: ":";
}
dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
margin-left: 0em;
margin-bottom: 0em;
}
dl {
margin-bottom: 15px;
}
dd > :first-child {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
dl > dd:last-child,
dl > dd:last-child > :last-child {
margin-bottom: 0;
}
dt:target, span.highlighted {
background-color: #fbe54e;
}
rect.highlighted {
fill: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.optional {
font-size: 1.3em;
}
.sig-paren {
font-size: larger;
}
.versionmodified {
font-style: italic;
}
.system-message {
background-color: #fda;
padding: 5px;
border: 3px solid red;
}
.footnote:target {
background-color: #ffa;
}
.line-block {
display: block;
margin-top: 1em;
margin-bottom: 1em;
}
.line-block .line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 1.5em;
}
.guilabel, .menuselection {
font-family: sans-serif;
}
.accelerator {
text-decoration: underline;
}
.classifier {
font-style: oblique;
}
.classifier:before {
font-style: normal;
margin: 0.5em;
content: ":";
}
abbr, acronym {
border-bottom: dotted 1px;
cursor: help;
}
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
pre, div[class|="highlight"] {
clear: both;
}
span.pre {
-moz-hyphens: none;
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
}
div[class^="highlight-"] {
margin: 1em 0;
}
td.linenos pre {
border: 0;
background-color: transparent;
color: #aaa;
}
table.highlighttable {
display: block;
}
table.highlighttable tbody {
display: block;
}
table.highlighttable tr {
display: flex;
}
table.highlighttable td {
margin: 0;
padding: 0;
}
table.highlighttable td.linenos {
padding-right: 0.5em;
}
table.highlighttable td.code {
flex: 1;
overflow: hidden;
}
.highlight .hll {
display: block;
}
div.highlight pre,
table.highlighttable pre {
margin: 0;
}
div.code-block-caption + div {
margin-top: 0;
}
div.code-block-caption {
margin-top: 1em;
padding: 2px 5px;
font-size: small;
}
div.code-block-caption code {
background-color: transparent;
}
table.highlighttable td.linenos,
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
}
div.code-block-caption span.caption-number {
padding: 0.1em 0.3em;
font-style: italic;
}
div.code-block-caption span.caption-text {
}
div.literal-block-wrapper {
margin: 1em 0;
}
code.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
}
code.descclassname {
background-color: transparent;
}
code.xref, a code {
background-color: transparent;
font-weight: bold;
}
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
background-color: transparent;
}
.viewcode-link {
float: right;
}
.viewcode-back {
float: right;
font-family: sans-serif;
}
div.viewcode-block:target {
margin: -1px -10px;
padding: 0 10px;
}
/* -- math display ---------------------------------------------------------- */
img.math {
vertical-align: middle;
}
div.body div.math p {
text-align: center;
}
span.eqno {
float: right;
}
span.eqno a.headerlink {
position: absolute;
z-index: 1;
}
div.math:hover a.headerlink {
visibility: visible;
}
/* -- printout stylesheet --------------------------------------------------- */
@media print {
div.document,
div.documentwrapper,
div.bodywrapper {
margin: 0 !important;
width: 100%;
}
div.sphinxsidebar,
div.related,
div.footer,
#top-link {
display: none;
}
}

View File

@ -0,0 +1 @@
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 434 KiB

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,315 @@
/*
* doctools.js
* ~~~~~~~~~~~
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/**
* select a different prefix for underscore
*/
$u = _.noConflict();
/**
* make the code below compatible with browsers without
* an installed firebug like debugger
if (!window.console || !console.firebug) {
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
"profile", "profileEnd"];
window.console = {};
for (var i = 0; i < names.length; ++i)
window.console[names[i]] = function() {};
}
*/
/**
* small helper function to urldecode strings
*/
jQuery.urldecode = function(x) {
return decodeURIComponent(x).replace(/\+/g, ' ');
};
/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;
/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};
/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};
/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];
return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
/**
* Small JavaScript module for the documentation.
*/
var Documentation = {
init : function() {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
this.initOnKeyListeners();
}
},
/**
* i18n support
*/
TRANSLATIONS : {},
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
LOCALE : 'unknown',
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
gettext : function(string) {
var translated = Documentation.TRANSLATIONS[string];
if (typeof translated === 'undefined')
return string;
return (typeof translated === 'string') ? translated : translated[0];
},
ngettext : function(singular, plural, n) {
var translated = Documentation.TRANSLATIONS[singular];
if (typeof translated === 'undefined')
return (n == 1) ? singular : plural;
return translated[Documentation.PLURALEXPR(n)];
},
addTranslations : function(catalog) {
for (var key in catalog.messages)
this.TRANSLATIONS[key] = catalog.messages[key];
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
this.LOCALE = catalog.locale;
},
/**
* add context elements like header anchor links
*/
addContextElements : function() {
$('div[id] > :header:first').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this headline')).
appendTo(this);
});
$('dt[id]').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this definition')).
appendTo(this);
});
},
/**
* workaround a firefox stupidity
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
*/
fixFirefoxAnchorBug : function() {
if (document.location.hash && $.browser.mozilla)
window.setTimeout(function() {
document.location.href += '';
}, 10);
},
/**
* highlight the search words provided in the url in the text
*/
highlightSearchWords : function() {
var params = $.getQueryParameters();
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
if (terms.length) {
var body = $('div.body');
if (!body.length) {
body = $('body');
}
window.setTimeout(function() {
$.each(terms, function() {
body.highlightText(this.toLowerCase(), 'highlighted');
});
}, 10);
$('<p class="highlight-link"><a href="javascript:Documentation.' +
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
.appendTo($('#searchbox'));
}
},
/**
* init the domain index toggle buttons
*/
initIndexTable : function() {
var togglers = $('img.toggler').click(function() {
var src = $(this).attr('src');
var idnum = $(this).attr('id').substr(7);
$('tr.cg-' + idnum).toggle();
if (src.substr(-9) === 'minus.png')
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
else
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
}).css('display', '');
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
togglers.click();
}
},
/**
* helper function to hide the search marks again
*/
hideSearchWords : function() {
$('#searchbox .highlight-link').fadeOut(300);
$('span.highlighted').removeClass('highlighted');
},
/**
* make the url absolute
*/
makeURL : function(relativeURL) {
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
},
/**
* get the current relative url
*/
getCurrentURL : function() {
var path = document.location.pathname;
var parts = path.split(/\//);
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
if (this === '..')
parts.pop();
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
},
initOnKeyListeners: function() {
$(document).keydown(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box or textarea
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
&& !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
switch (event.keyCode) {
case 37: // left
var prevHref = $('link[rel="prev"]').prop('href');
if (prevHref) {
window.location.href = prevHref;
return false;
}
case 39: // right
var nextHref = $('link[rel="next"]').prop('href');
if (nextHref) {
window.location.href = nextHref;
return false;
}
}
}
});
}
};
// quick alias for translations
_ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
});

View File

@ -0,0 +1,12 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.1.0',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
FILE_SUFFIX: '.html',
LINK_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false
};

BIN
openapi/docs/build/html/_static/file.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 286 B

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 434 KiB

Binary file not shown.

Binary file not shown.

Binary file not shown.

Some files were not shown because too many files have changed in this diff Show More