From 4d627c8f83ce47fbacc78123403c99c74d150890 Mon Sep 17 00:00:00 2001 From: Andrew Clayton Date: Tue, 17 Sep 2024 22:37:21 +0100 Subject: docs/unit-openapi.yaml: Update version for 1.33.0 Better late than never! Signed-off-by: Andrew Clayton --- docs/unit-openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/unit-openapi.yaml') diff --git a/docs/unit-openapi.yaml b/docs/unit-openapi.yaml index 3acc1416..efe2f63b 100644 --- a/docs/unit-openapi.yaml +++ b/docs/unit-openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.0 info: - title: "NGINX Unit 1.32.0" + title: "NGINX Unit 1.33.0" description: "NGINX Unit is a lightweight and versatile application runtime that provides the essential components for your web application as a single open-source server: running application code, serving static assets, -- cgit From e1fd14f7749c35a48a480cbfc1ca2da74f84a0a1 Mon Sep 17 00:00:00 2001 From: Ava Hahn Date: Thu, 7 Nov 2024 14:12:24 -0800 Subject: docs/openapi: update OpenAPI references These changes are generated by the openapi generator through a make command. Signed-off-by: Ava Hahn Signed-off-by: Gabor Javorszky --- docs/unit-openapi.yaml | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) (limited to 'docs/unit-openapi.yaml') diff --git a/docs/unit-openapi.yaml b/docs/unit-openapi.yaml index efe2f63b..6147bf40 100644 --- a/docs/unit-openapi.yaml +++ b/docs/unit-openapi.yaml @@ -3090,6 +3090,68 @@ paths: "404": $ref: "#/components/responses/responseNotFound" + /config/settings/telemetry: + summary: "Endpoint for the `telemetry` object in `settings`" + get: + operationId: getSettingsTelemetry + summary: "Retrieve the `telemetry` object from settings" + description: "Retrieves the `telemetry` object that represents Unit's + [Telemetry settings](https://unit.nginx.org/configuration/#settings)." + tags: + - settings + - config + responses: + "200": + description: "Ok; the `telemetry` object exists in the configuration." + content: + application/json: + schema: + $ref: "#/components/schemas/configSettingsTelemetry" + "404": + $ref: "#/components/responses/responseNotFound" + + put: + operationId: putSettingsTelemetry + summary: "Create or update the `telemetry` object in settings" + description: "Creates or updates the `telemetry` object that represents Unit's + [Telemetry settings](https://unit.nginx.org/configuration/#settings)." + tags: + - settings + - config + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/configSettingsTelemetry" + responses: + "200": + $ref: "#/components/responses/responseOkUpdated" + + "400": + $ref: "#/components/responses/responseBadRequest" + + "404": + $ref: "#/components/responses/responseNotFound" + + "500": + $ref: "#/components/responses/responseInternalError" + + delete: + operationId: deleteSettingsTelemetry + summary: "Delete the telemetry object" + description: "Deletes the `telemetry` object from the configuration." + tags: + - settings + - config + + responses: + "200": + $ref: "#/components/responses/responseOkDeleted" + + "404": + $ref: "#/components/responses/responseNotFound" + /config/settings/http: summary: "Endpoint for the `http` object in `settings`" @@ -6545,10 +6607,38 @@ components: Unit settings." properties: + telemetry: + description: "Represents global telemetry settings in Unit." + $ref: "#/components/schemas/configSettingsTelemetry" + http: description: "Represents global HTTP settings in Unit." $ref: "#/components/schemas/configSettingsHttp" + # /config/settings/telemetry + configSettingsTelemetry: + type: object + description: "An object whose options represent global telemetry settings in Unit." + required: ["endpoint"] + properties: + batch_size: + type: integer + description: "Number of spans to cache before sending to telemetry collector." + default: 128 + + endpoint: + type: string + description: "A valid endpoint to which Unit can send OpenTelemetry spans." + + protocol: + type: string + description: "Protocol to use when communicating with the aforementioned endpoint." + + sampling_ratio: + type: number + default: 1 + description: "A number in between 0 and 1 that describes the percent of requests traced" + # /config/settings/http configSettingsHttp: type: object -- cgit From ecb0f21d5d920878b97e0ae41c7eaf09cc796cfd Mon Sep 17 00:00:00 2001 From: Andrew Clayton Date: Wed, 11 Dec 2024 22:19:58 +0000 Subject: docs/unit-openapi.yaml: Update version for 1.34.0 Signed-off-by: Andrew Clayton --- docs/unit-openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/unit-openapi.yaml') diff --git a/docs/unit-openapi.yaml b/docs/unit-openapi.yaml index 6147bf40..419b8da2 100644 --- a/docs/unit-openapi.yaml +++ b/docs/unit-openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.0 info: - title: "NGINX Unit 1.33.0" + title: "NGINX Unit 1.34.0" description: "NGINX Unit is a lightweight and versatile application runtime that provides the essential components for your web application as a single open-source server: running application code, serving static assets, -- cgit