From 831c1f8d3c8deedd9e26bcde4ad5d15d8a8f406b Mon Sep 17 00:00:00 2001 From: Koichi Edagawa Date: Tue, 13 Sep 2022 10:04:20 +0900 Subject: [PATCH] Update API doc for vnf packages list with paging This patch adds the description for paging large query results of target NFV Orchestration API below into the API document. - {apiRoot}/vnfpkgm/v1/vnf_packages Implements: blueprint paging-query-result Change-Id: I0c8151613193cb90944a1103c2b3359de227f37a --- api-ref/source/v1/vnf_packages.inc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/api-ref/source/v1/vnf_packages.inc b/api-ref/source/v1/vnf_packages.inc index 695de2c76..2acf15a81 100644 --- a/api-ref/source/v1/vnf_packages.inc +++ b/api-ref/source/v1/vnf_packages.inc @@ -67,6 +67,13 @@ List VNF Packages Lists VNF Packages. +If a response includes a LINK HTTP header (see IETF RFC 8288 [#RFC8288]_) 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] + https://datatracker.ietf.org/doc/html/rfc8288 + Response Codes --------------