From a2a0dfb33a934bc93a1b523056ae2c731cb979a2 Mon Sep 17 00:00:00 2001 From: Matthew Watkins Date: Mon, 2 Mar 2026 15:24:29 +0000 Subject: [PATCH] Docs: Update api-swagger-guide to reference openapi directive Update the API documentation guide to consistently reference the openapi directive instead of the deprecated swaggerv2doc directive. The code examples were already updated but the surrounding prose and notes still referenced the old directive name. Issue-ID: CIMAN-33 Change-Id: Ie4a7afa4473790f1555a2f1ab22f23d0f67980f6 Signed-off-by: Matthew Watkins --- docs/guides/onap-documentation/api-swagger-guide.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/guides/onap-documentation/api-swagger-guide.rst b/docs/guides/onap-documentation/api-swagger-guide.rst index d56dfa45a..bdc258a3e 100644 --- a/docs/guides/onap-documentation/api-swagger-guide.rst +++ b/docs/guides/onap-documentation/api-swagger-guide.rst @@ -79,17 +79,17 @@ The code is available here: The syntax of is to be taken literally. Keep '<' and '>'. -API Swagger ------------ -For each API, the ``swaggerv2doc`` directive must be used as follows: +API Documentation Rendering +---------------------------- +For each API, the ``openapi`` directive must be used as follows: .. note:: - Note the “v” in swaggerv2doc! + The ``openapi`` directive replaces the deprecated ``swaggerv2doc`` directive. If your JSON file has multiple endpoints, this directive does not preserve the order. .. note:: - swaggerv2doc directive may generate errors when Swagger file contains specific - information. In such case, do not use this directive. + The ``openapi`` directive may generate errors when the specification file contains + unsupported or malformed content. In such cases, do not use this directive. .. code:: rst -- 2.16.6