openstack
/
tacker
Code Issues Proposed changes

Merge "Update API doc for paging large query results"

This commit is contained in:
Zuul 2022-06-13 01:25:53 +00:00 committed by Gerrit Code Review
parent e5a39d37f3 8b5969e459
commit 8a7d3e70c1
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
api-ref/source/v1/vnflcm.inc
View File

@ -433,6 +433,13 @@ The GET method queries information about multiple VNF instances.
In Victoria release, added attribute-based filtering expression (for VnfInstance)
that follows clause 5.2 of ETSI GS NFV SOL13.
If a response includes a LINK HTTP header (see IETF RFC 8288 [#RFC8288-1]_) with the "rel" attribute
set to "next", the API consumer can send a GET request to the URI communicated in
the LINK header to obtain the next page of results.
.. [#RFC8288-1]
https://datatracker.ietf.org/doc/html/rfc8288
Response Codes
--------------
@ -875,6 +882,13 @@ List VNF LCM operation occurrence
The API consumer can use this method to query status information about multiple VNF lifecycle management operation
occurrences.
If a response includes a LINK HTTP header (see IETF RFC 8288 [#RFC8288-2]_) with the "rel" attribute
set to "next", the API consumer can send a GET request to the URI communicated in
the LINK header to obtain the next page of results.
.. [#RFC8288-2]
https://datatracker.ietf.org/doc/html/rfc8288
Response Codes
--------------
@ -1279,6 +1293,13 @@ List subscription
The GET method queries the list of active subscriptions of the functional block that invokes the method.
It can be used e.g. for resynchronization after error situations.
If a response includes a LINK HTTP header (see IETF RFC 8288 [#RFC8288-3]_) with the "rel" attribute
set to "next", the API consumer can send a GET request to the URI communicated in
the LINK header to obtain the next page of results.
.. [#RFC8288-3]
https://datatracker.ietf.org/doc/html/rfc8288
Response Codes
--------------