Commit Graph

31 Commits

Author SHA1 Message Date
songwenping e090890c02 Remove unicode from code in api-ref conf
In python 3, all strings are considered as unicode string.

This patch drops the explicit unicode literal (u'...')
or (u"..") appearances from the unicode strings.

Change-Id: Ia3daf3f63ddfe0a6494ecb02413d495743ca0d3d
2021-10-25 03:09:33 +00:00
Andreas Jaeger 7977b49dda Cleanup Python 2.7 support
OpenStack is dropping the py2.7 support in ussuri cycle.

Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Remove ancient pbr section from setup.cfg
- Update requirements
- Use newer openstackdocstheme and setup storyboard support for it
- Remove Babel as requirement, this is not needed here anymore.

Change-Id: I0fd6fbdcbe788b0dfc2b1e20989b0a19ceec59f5
2020-04-22 08:31:22 +02:00
pengyuesheng 9f0f1b9472 Bump the openstackdocstheme extension to 1.20
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

This will show other versions of the doc, too.

Change-Id: Id73bbf0a844dee39f9c72df72b1bdb49fa094806
2019-07-01 15:25:28 +08:00
Telles Nobrega 0b8002a99d APIv2 - api-ref documentation for APIv2
Writing api-ref for APIv2.

Story: #2002102
Task: #19780

Change-Id: Ib9e855c11f03239e70306d12e96194549d2dc0f3
2019-01-07 14:59:23 -03:00
Luigi Toscano 8b830df305 api-ref: move to a v1.1 sub-folder
Make space for v2.
It should not break too much existing links, only the links to
local anchors (like #clusters, #jobs, etc) will be broken,
because it is not possible to redirect server-side based on an
URL fragment like that.
Luckily the generated content ends all in the same HTML page,
so the old links will end up in the new top-level index
which points to the index for v1.1 API documentation (and later
for v2). Not too bad.

Change-Id: I9a75e6567798b8d6d3deed8fc66e362ad2d86b5a
2018-07-12 18:52:52 +02:00
Luigi Toscano 3734ef7f5e Migration to Storyboard
Sahara projects migrated to storyboard.openstack.org.
Replace the references to Launchpad, including the rename of
a documentation page focuse on launchpad (which would
probably require a redirect on the openstack.org site),
and clean up some old details about blueprints.
Fix the bug links in the openstackdocstheme configuration.

Change-Id: I30642356f1b1076a874f14fc43fad234fa9a098d
2018-03-17 15:56:58 +01:00
Zuul a7a22afbcc Merge "Change some parameters to be required in api-ref" 2018-02-19 16:34:15 +00:00
leiyashuai e0a7d03dee Change some parameters to be required in api-ref
These three parameters are used in path. Change them to be required.

Change-Id: I9c247b7ebefce59d499c495601b33a3aba7063c0
2018-02-12 11:34:56 +08:00
“leiyashuai” 6861df5289 Fix the parameter in api-ref
Here, the mapping of parameter 'image_id' is wrong since it is used in path.
So, fix it.

Change-Id: I582f4bbd39407c27c0875db11d8f70f82bc2576e
2018-02-12 10:39:32 +08:00
Luigi Toscano 541edfc8ef doc: update the configuration of the theme
Use the configuration options described in the documentation of
openstackdocstheme and clean up some old options on the way.

Change-Id: I16972c7fa1102baf66bd4478e03c0f6c77096788
2017-07-03 22:40:55 +02:00
M V P Nitesh 187b218bac Fix doc generation for Python3
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpeted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Change-Id: Iccad9d5766e0e6641133b7d5dd8c49e13adb2b1f
2017-04-17 17:04:49 +05:30
Andreas Jaeger 8ed10235c6 Fix api-ref build
With current os-api-ref and Sphinx 1.5, there were a couple of problems
in building api-ref: Wrong order of entries, wrong names.

Fix all so that api-ref builds again.

Also, tread warnings as errors for built so that no new problems get
introduced.

Change-Id: I6fbae3e93632472c60f848868b55cb7206ee76a9
2017-03-04 12:51:58 +01:00
Shu Yingya 6ccc0997c7 [Api-ref] fix description of response parameters
There is something wrong in API ref, this changes fixed it:
1. change the response parameter description of "description",
   "id" and "name" and so on
2. some request parameter in the url path should be marked as
   "required"

Change-Id: I738fc5a3f490f9cc321349445249f7dcd9aaf4e7
Closes-Bug: 1636522
2017-02-07 20:04:16 +08:00
Jenkins 5ce7ad4e90 Merge "Replacement of project name in api-ref." 2017-02-02 20:09:54 +00:00
Gökhan IŞIK c9681132a7 Replacement of project name in api-ref.
The keystone resource was renamed from 'tenant' to 'project',
this patch replaces 'tenant' with 'project' in api-ref
documents of sahara.

Change-Id: I1f41757b3ec90f88926681d4a0b7767764c37c4a
Closes-Bug: #1626678
2017-02-02 05:57:47 +00:00
Nam Nguyen Hoai 59aa40c571 API: Updating error response codes
Follow source code: https://github.com/openstack/sahara/blob/master/sahara/utils/api.py#L187-L229

It should be updated status code for response request.

Change-Id: I8ee936ba033c28342b59ee5af6dd3e565ae38f22
2017-01-20 16:38:32 +07:00
zhouyunfeng 582c382bf3 totally changed requred to required
Change-Id: Ia9bdcc2bfdeeee3b6efff0e673e7dda7b6ac5fc3
2016-11-15 17:17:03 +08:00
Jenkins eeff15f358 Merge "[api-ref] Fix missprints in response codes" 2016-10-31 16:36:24 +00:00
Mikhail 90f4529d3d [api-ref] Fix missprints in response codes
There is missprints in description of success/
error codes of POST, PUT, PATCH and DELETE
requests.

Change-Id: I251aedd6742e39fc0ba6ddbb72214cfc0f7ed099
Closes-bug: #1631410
2016-10-07 18:24:40 +03:00
pawnesh.kumar 5666dfe2c3 Remove html_static_path from api-ref
In Id3a71841f5b9a9ea7bb5803afd967ab4feadfe10 the in tree copy of
os-api-ref was migrated to the upstream version. The html_static_path
setting in conf.py was forgotten in the patch, which caused a warning
when building the API reference.
This patch comments out the setting from conf.py to prevent the
warning.

TrivialFix

Change-Id: I595a5a85db9fbacdf17f1bc4706ee4cc6705d81a
2016-10-06 05:23:51 +00:00
Shu Yingya 3a4a3a09f1 [Doc] add description of "plugin update" to api ref
There is a new method "plugins_update" in file[1],
but still didn't add into doc.

[1]: https://github.com/openstack/sahara/blob/master/sahara/api/v10.py#L216-L221

Change-Id: Ieb8e5cb616b27bb997162229e6f3867f5a0a2c3f
2016-09-01 06:17:31 +08:00
Jenkins ccd2e07bad Merge "[DOC] Add docs about pagination abilities" 2016-09-07 20:48:14 +00:00
Mikhail Lelyakin f41bb7dd26 [DOC] Add docs about pagination abilities
Pagination abilities are described in
doc/source/restapi.rst file and in api-ref

Change-Id: Ia653f1fb22a640299a1d2642ea11d9b0215dc000
bp: pagination
2016-09-07 16:13:24 +03:00
Ha Van Tu 3a40553df6 [api-ref] Stop supporting os-api-ref 1.0.0
The os-api-ref 1.0.0 is out. We can remove the support to older
version now.
Reference: https://github.com/openstack/senlin/commit/
6d41feb58dd836d426c9b6f025846dbbf7295097
https://review.openstack.org/#/c/362170/

Change-Id: Ia9155b5695f471fce2b8226f954d2a9a2576b9cd
2016-09-07 14:20:03 +07:00
Michael Ionkin e4207c8f93 Update api-ref docs for Designate feature
Change-Id: I4c0129c64ac34f0cce5ba4049ec857dfcd5660a8
2016-09-05 16:50:41 +03:00
Jenkins 951a43ee80 Merge "[DOC] Fix misprints in api-ref" 2016-09-03 09:33:01 +00:00
Mikhail Lelyakin 89708bba68 [DOC] Fix misprints in api-ref
In Job binaries endpoints was missed
job_binary_id parameter.

Change-Id: Ifaa4ec53c3c896496649de4f3d908a32f8ec02dd
2016-09-02 17:24:18 +03:00
Ha Van Tu fe46ce8aac Config logABug feature for Sahara api-ref
Currently, Sahara api-ref is not configured with logABug feature.
When users click "Report bug" button, it leads to
"bugs.launchpad.net/openstack-manuals" which is default.
We should change it to "bugs.launchpad.net/sahara/"

Change-Id: Ifab40f90d447680b9a03451756a91705e1596702
2016-08-31 12:57:38 +07:00
Graham Hayes 2e74ca0db4 Get ready for os-api-ref sphinx theme change
Change-Id: I94be054dd5e44a165566bff50512b8854c0e5dd1
2016-08-19 16:44:05 +01:00
Vitaly Gridnev 694549dce0 fix building api ref docs
Change-Id: I93f6d95de00bb7d0c3f93430ff2f1532e54e31c8
2016-07-07 00:23:58 +03:00
Nikita Konovalov c27c5cae42 Moving WADL docs to Sahara repository
To comply with recent documentation policies
the API documentaion should be maintained within
the project source repository.

Change-Id: I0f854eea33d1a895580589e91c17c89e42b3df0a
2016-06-21 10:52:25 +02:00