diff options
author | Andrew Clayton <a.clayton@nginx.com> | 2024-08-20 19:43:19 +0100 |
---|---|---|
committer | Andrew Clayton <a.clayton@nginx.com> | 2024-08-21 00:54:09 +0100 |
commit | 05b1c769735667be8ad4a105296eb072f6f58076 (patch) | |
tree | 1d5b7a7e65e2c28badc8e9f00a1b9ec733a9d655 /docs | |
parent | cad6aed526b38d52f13266120f9a4381f9a22cad (diff) | |
download | unit-05b1c769735667be8ad4a105296eb072f6f58076.tar.gz unit-05b1c769735667be8ad4a105296eb072f6f58076.tar.bz2 |
docs/openapi: Fix brokenness
- Missing end quotes
- Wrong indentation
- Missing langMod parameter definition
- Wrong type specification
Fixes: ae4795aa1 ("docs/openapi: Add entries for the new /status/modules endpoint")
Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/unit-openapi.yaml | 105 |
1 files changed, 62 insertions, 43 deletions
diff --git a/docs/unit-openapi.yaml b/docs/unit-openapi.yaml index 6c4d4e00..9a2c7ec8 100644 --- 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: |