Docs: Update api-swagger-guide to reference openapi directive 31/143431/1
authorMatthew Watkins <mwatkins@linuxfoundation.org>
Mon, 2 Mar 2026 15:24:29 +0000 (15:24 +0000)
committerMatthew Watkins <mwatkins@linuxfoundation.org>
Mon, 2 Mar 2026 15:24:29 +0000 (15:24 +0000)
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 <mwatkins@linuxfoundation.org>
docs/guides/onap-documentation/api-swagger-guide.rst

index d56dfa4..bdc258a 100644 (file)
@@ -79,17 +79,17 @@ The code is available here:
    The syntax of <myAPI1.json> 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