Commit Graph

19 Commits

Author SHA1 Message Date
LiZekun fe2abe1130 Remove unicode literal from code
All strings are considered as unicode literal string from Python 3.

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

Change-Id: I662c72686a7e0404da62fb677c666885ff5ac65a
2022-10-27 11:31:43 -07:00
Tadeas Kot ff93c7799f Add support for state selector in the list introspection
This commit add support for state selector to the list introspection.

* ``GET /v1/introspection?state=[starting, waiting, processing,
                                 finished, error, reapplying,
				 enrolling]``

Story: 1625183
Task: 11350
Change-Id: I2c5222110487a08a4e7b1efbcbc5dc3d552fae3e
2021-09-27 14:03:58 +02:00
Zuul 42a77a45e1 Merge "CI: run doc8 on api-ref" 2020-08-12 08:08:45 +00:00
Zuul 73a97eb606 Merge "Listen on :: by default" 2020-08-10 10:20:43 +00:00
Dmitry Tantsur 9de65e337a Normalize formatting in the API versions reference
Change-Id: I6123e8fd197b18c02de03e8cb9ced5a7ddf91ed7
2020-08-07 13:25:21 +02:00
Dmitry Tantsur 6a8d46b33b Listen on :: by default
On most target systems it will make it available on both V4 and V6.

Change-Id: Ie918bc8572ff7f0ce2712cbb248e8ee9bf4c3d20
2020-08-07 12:17:57 +02:00
Dmitry Tantsur a5e8cce1af CI: run doc8 on api-ref
Change-Id: I000ffe5915a1c74b0e4eeb93ceeb4aee429a1901
2020-07-28 12:45:47 +02:00
Dmitry Tantsur bd16d80005 Remove built-in API documentation in favour of API-REF
A few items have been migrated from the former to the latter.

Change-Id: Icc4f00b872a2550ff886287d8f0844ee2593f296
2020-07-28 12:39:28 +02:00
Dmitry Tantsur cc7fcf4332 Add support for retrieving unprocessed data
Change-Id: I3c0070d0c1f5d12e98f914be44f4ed52b01ea043
2020-07-28 12:19:19 +02:00
Andreas Jaeger 68ab6a01b6 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Set openstackdocs_auto_version to not auto-version the documents.

Set openstackdocs_auto_name to use 'project' as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

Change-Id: I9591e0f0215e9eb790ec2e3ea1a7ccbd55bb76d0
2020-05-20 10:59:56 +02:00
Zygimantas Matonis e2c8f9fd7b Added scope to introspection rules.
Added 'scope' property to IntrospectionRule and logic to check if a node
falls in the same scope.This allows introspection rules to be applied on
selected nodes instead of every one of them.

Story: 2006995
Task: 37763

Change-Id: I77034f032ea0ec16886afdd928546eb801f7a90a
2020-03-26 21:40:43 +01:00
Kaifeng Wang 29d8515f50 Support reapply with supplied introspection data
This patch adds support to provide unprocessed introspection data
to reapply a node. The provided introspection data will be save to
current introspection storage backend.

Change-Id: I969ae9c32f53f89c006a64a006388ddea9542aa5
Story: 1564863
Task: 11344
2019-04-15 15:04:33 +00:00
Zuul 47b9468838 Merge "Follow up to api-ref revision" 2019-04-02 08:41:36 +00:00
Riccardo Pittau d9f2f4f894 Removing two deprecated values from json responses
This patch removes two reserved fields, ``switch_port_descr`` and
``switch_chassis_descr``, from the json request and response
examples in api-ref, that were still present despite having been
removed from the ironic-python-agent code base during
ocata cycle[0].

[0]73f316d804 (diff-664ce09492251bb45bf8a2fb7c1a5f18)

Change-Id: I6446e167b957b94bc9bb7f6737bcf57e94a4433a
2019-03-14 15:18:18 +01:00
Kaifeng Wang 688c6ebd15 Follow up to api-ref revision
Addressing commments from https://review.openstack.org/#/c/613515

Contents about introspection sub resouces are moved to a new file.

Change-Id: Icd3efb902e6f836dad653011a96edc84a3feea7c
2019-03-14 15:24:19 +08:00
Kaifeng Wang 6c4e6760c4 Revise api-ref docs
Follow up to https://review.openstack.org/#/c/495752

Addressed some comments from rloo, as well as some other issues.

Change-Id: I3cdcac63b43c6b51f913d230153c1f8650426478
2019-03-06 05:13:51 +00:00
Riccardo Pittau bce5b3ec35 [trivial] removing pagination in Get Introspection Data api-ref
Removing the mention of pagination in the API reference of Get
Introspection Data as it's not supported.
Follow-up of https://review.openstack.org/640288

Depends-On: https://review.openstack.org/640910/

Change-Id: I61e1689fdb8c74d4c898e10911781e9a2f7a82e9
2019-03-05 16:59:51 +01:00
Riccardo Pittau b087e94d81 Removing mention of limit in Get Introspection Data api-ref
The optional query parameter 'limit' is not supported by the
request done to get introspection data.
This patch removes it from the api document reference to avoid
confusion.

Change-Id: I90777d426809ef719817198e6baade8442d60041
2019-03-01 10:55:06 +01:00
Anton Arefiev 05a86b3d57 Add API reference
Add initial API reference, which covers all inspector endpoits.

The conf.py and the tox environment are stolen from ironic.

Co-Authored-By: Kaifeng Wang <kaifeng.w@gmail.com>
Change-Id: I5009e8708dcad8ab25380f7bf574125d6e758ef5
2018-10-16 16:50:01 +08:00