docs/openapi: Fix brokenness

- Missing end quotes - Wrong indentation - Missing langMod parameter definition - Wrong type specification Fixes: ae4795a ("docs/openapi: Add entries for the new /status/modules endpoint") Signed-off-by: Andrew Clayton <[email protected]>
nginx · Aug 20, 2024 · 05b1c76 · 05b1c76
1 parent cad6aed
commit 05b1c76
Showing 1 changed file with 62 additions and 43 deletions.
diff --git a/docs/unit-openapi.yaml b/docs/unit-openapi.yaml
@@ -3959,24 +3959,27 @@ paths:
       description: "Retrieves the language `module` object that represents a
         currently loaded language module."
 
-    tags:
-      - status
+      tags:
+        - status
 
-    responses:
-      "200":
-        description: "OK; the language `module` object exists."
+      parameters:
+        - $ref: "#/components/parameters/langMod"
 
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/StatusModulesLang"
+      responses:
+        "200":
+          description: "OK; the language `module` object exists."
 
-          examples:
-            example1:
-              $ref: "#/components/examples/statusModulesLang
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/statusModulesLang"
 
-      "404":
-        $ref: "#/components/responses/responseNotFound"
+              examples:
+                example1:
+                  $ref: "#/components/examples/statusModulesLang"
+
+        "404":
+          $ref: "#/components/responses/responseNotFound"
 
   /status/modules/{langMod}/version:
     summary: "Endpoint for the loaded language module `version` object"
@@ -3986,24 +3989,27 @@ paths:
       description: "Retrieves the language module `version` object that
         represents the version of a currently loaded language module."
 
-    tags:
-      - status
+      tags:
+        - status
 
-    responses:
-      "200":
-        description: "OK; the language module `version` object exists."
+      parameters:
+        - $ref: "#/components/parameters/langMod"
 
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/StatusModulesLangVersion"
+      responses:
+        "200":
+          description: "OK; the language module `version` object exists."
 
-          examples:
-            example1:
-              $ref: "#/components/examples/statusModulesLangVersion
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/statusModulesLangVersion"
 
-      "404":
-        $ref: "#/components/responses/responseNotFound"
+              examples:
+                example1:
+                  $ref: "#/components/examples/statusModulesLangVersion"
+
+        "404":
+          $ref: "#/components/responses/responseNotFound"
 
   /status/modules/{langMod}/lib:
     summary: "Endpoint for the loaded language module `lib` object"
@@ -4013,24 +4019,27 @@ paths:
       description: "Retrieves the language module `lib` object that represents
         the file path to the loaded language module."
 
-    tags:
-      - status
+      tags:
+        - status
 
-    responses:
-      "200":
-        description: "OK; the language module `lib` object exists."
+      parameters:
+        - $ref: "#/components/parameters/langMod"
 
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/StatusModulesLangLib"
+      responses:
+        "200":
+          description: "OK; the language module `lib` object exists."
 
-          examples:
-            example1:
-              $ref: "#/components/examples/statusModulesLangLib
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/statusModulesLangLib"
+
+              examples:
+                example1:
+                  $ref: "#/components/examples/statusModulesLangLib"
 
-      "404":
-        $ref: "#/components/responses/responseNotFound"
+        "404":
+          $ref: "#/components/responses/responseNotFound"
 
   /status/connections:
     summary: "Endpoint for the `connections` status object"
@@ -4474,6 +4483,14 @@ components:
       schema:
         type: string
 
+    langMod:
+      in: path
+      description: "A language modules name in the modules status."
+      name: langMod
+      required: true
+      schema:
+        type: string
+
     listenerName:
       in: path
       description: "Listener name; a unique combination of a host IP address
@@ -6495,7 +6512,9 @@ components:
     statusModulesLang:
       description: "Lists currently loaded versions of the specified language
         module."
-      type: array or object
+      oneOf:
+        - type: string
+        - type: object
 
     # /status/modules/{langMod}/version
     statusModulesLangVersion: