From 8b5969e459b862a5c2f5b0617489704d23e98d86 Mon Sep 17 00:00:00 2001 From: Koichi Edagawa Date: Thu, 31 Mar 2022 12:07:30 +0900 Subject: [PATCH] Update API doc for paging large query results This patch adds the description for paging large query results of target NFV Orchestration APIs below supported in Yoga into the API document. - {apiRoot}/vnflcm/v1/vnf_lcm_op_occs - {apiRoot}/vnflcm/v1/vnf_instances - {apiRoot}/vnflcm/v1/subscriptions Change-Id: Ic173bde521caccf0f683a1308d80de152bbe1c5f --- api-ref/source/v1/vnflcm.inc | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/api-ref/source/v1/vnflcm.inc b/api-ref/source/v1/vnflcm.inc index 5a5da373a..202304ae8 100644 --- a/api-ref/source/v1/vnflcm.inc +++ b/api-ref/source/v1/vnflcm.inc @@ -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 --------------