From ac4e1e7402902042d942cb17805495b8f49dc871 Mon Sep 17 00:00:00 2001 From: Simran Spiller Date: Thu, 21 Aug 2025 18:01:05 +0200 Subject: [PATCH 1/2] HTTP API: Fix misleading schema description of Foxx service re-configuration --- site/content/3.11/develop/http-api/foxx.md | 24 +++++++--------------- site/content/3.12/develop/http-api/foxx.md | 24 +++++++--------------- site/content/3.13/develop/http-api/foxx.md | 24 +++++++--------------- 3 files changed, 21 insertions(+), 51 deletions(-) diff --git a/site/content/3.11/develop/http-api/foxx.md b/site/content/3.11/develop/http-api/foxx.md index a8b1e29bf4..9bbc9d07c1 100644 --- a/site/content/3.11/develop/http-api/foxx.md +++ b/site/content/3.11/develop/http-api/foxx.md @@ -476,7 +476,7 @@ paths: patch: operationId: updateFoxxConfiguration description: | - Replaces the given service's configuration. + Replaces the given service's configuration partially. Returns an object mapping all configuration option names to their new values. parameters: @@ -499,15 +499,10 @@ paths: content: application/json: schema: + description: | + A JSON object mapping configuration option names to their new values. + Any omitted options will be ignored. type: object - required: - - options - properties: - options: - description: | - A JSON object mapping configuration option names to their new values. - Any omitted options will be ignored. - type: object responses: '200': description: | @@ -547,15 +542,10 @@ paths: content: application/json: schema: + description: | + A JSON object mapping configuration option names to their new values. + Any omitted options will be reset to their default values or marked as unconfigured. type: object - required: - - options - properties: - options: - description: | - A JSON object mapping configuration option names to their new values. - Any omitted options will be reset to their default values or marked as unconfigured. - type: object responses: '200': description: | diff --git a/site/content/3.12/develop/http-api/foxx.md b/site/content/3.12/develop/http-api/foxx.md index a8b1e29bf4..9bbc9d07c1 100644 --- a/site/content/3.12/develop/http-api/foxx.md +++ b/site/content/3.12/develop/http-api/foxx.md @@ -476,7 +476,7 @@ paths: patch: operationId: updateFoxxConfiguration description: | - Replaces the given service's configuration. + Replaces the given service's configuration partially. Returns an object mapping all configuration option names to their new values. parameters: @@ -499,15 +499,10 @@ paths: content: application/json: schema: + description: | + A JSON object mapping configuration option names to their new values. + Any omitted options will be ignored. type: object - required: - - options - properties: - options: - description: | - A JSON object mapping configuration option names to their new values. - Any omitted options will be ignored. - type: object responses: '200': description: | @@ -547,15 +542,10 @@ paths: content: application/json: schema: + description: | + A JSON object mapping configuration option names to their new values. + Any omitted options will be reset to their default values or marked as unconfigured. type: object - required: - - options - properties: - options: - description: | - A JSON object mapping configuration option names to their new values. - Any omitted options will be reset to their default values or marked as unconfigured. - type: object responses: '200': description: | diff --git a/site/content/3.13/develop/http-api/foxx.md b/site/content/3.13/develop/http-api/foxx.md index a8b1e29bf4..9bbc9d07c1 100644 --- a/site/content/3.13/develop/http-api/foxx.md +++ b/site/content/3.13/develop/http-api/foxx.md @@ -476,7 +476,7 @@ paths: patch: operationId: updateFoxxConfiguration description: | - Replaces the given service's configuration. + Replaces the given service's configuration partially. Returns an object mapping all configuration option names to their new values. parameters: @@ -499,15 +499,10 @@ paths: content: application/json: schema: + description: | + A JSON object mapping configuration option names to their new values. + Any omitted options will be ignored. type: object - required: - - options - properties: - options: - description: | - A JSON object mapping configuration option names to their new values. - Any omitted options will be ignored. - type: object responses: '200': description: | @@ -547,15 +542,10 @@ paths: content: application/json: schema: + description: | + A JSON object mapping configuration option names to their new values. + Any omitted options will be reset to their default values or marked as unconfigured. type: object - required: - - options - properties: - options: - description: | - A JSON object mapping configuration option names to their new values. - Any omitted options will be reset to their default values or marked as unconfigured. - type: object responses: '200': description: | From 031d913c6b367f17150544824f02595f98a463a3 Mon Sep 17 00:00:00 2001 From: Simran Spiller Date: Thu, 21 Aug 2025 20:25:15 +0200 Subject: [PATCH 2/2] Add comma for readability --- site/content/3.11/develop/http-api/foxx.md | 4 ++-- site/content/3.12/develop/http-api/foxx.md | 4 ++-- site/content/3.13/develop/http-api/foxx.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/site/content/3.11/develop/http-api/foxx.md b/site/content/3.11/develop/http-api/foxx.md index 9bbc9d07c1..fae56bd0aa 100644 --- a/site/content/3.11/develop/http-api/foxx.md +++ b/site/content/3.11/develop/http-api/foxx.md @@ -500,7 +500,7 @@ paths: application/json: schema: description: | - A JSON object mapping configuration option names to their new values. + A JSON object, mapping configuration option names to their new values. Any omitted options will be ignored. type: object responses: @@ -543,7 +543,7 @@ paths: application/json: schema: description: | - A JSON object mapping configuration option names to their new values. + A JSON object, mapping configuration option names to their new values. Any omitted options will be reset to their default values or marked as unconfigured. type: object responses: diff --git a/site/content/3.12/develop/http-api/foxx.md b/site/content/3.12/develop/http-api/foxx.md index 9bbc9d07c1..fae56bd0aa 100644 --- a/site/content/3.12/develop/http-api/foxx.md +++ b/site/content/3.12/develop/http-api/foxx.md @@ -500,7 +500,7 @@ paths: application/json: schema: description: | - A JSON object mapping configuration option names to their new values. + A JSON object, mapping configuration option names to their new values. Any omitted options will be ignored. type: object responses: @@ -543,7 +543,7 @@ paths: application/json: schema: description: | - A JSON object mapping configuration option names to their new values. + A JSON object, mapping configuration option names to their new values. Any omitted options will be reset to their default values or marked as unconfigured. type: object responses: diff --git a/site/content/3.13/develop/http-api/foxx.md b/site/content/3.13/develop/http-api/foxx.md index 9bbc9d07c1..fae56bd0aa 100644 --- a/site/content/3.13/develop/http-api/foxx.md +++ b/site/content/3.13/develop/http-api/foxx.md @@ -500,7 +500,7 @@ paths: application/json: schema: description: | - A JSON object mapping configuration option names to their new values. + A JSON object, mapping configuration option names to their new values. Any omitted options will be ignored. type: object responses: @@ -543,7 +543,7 @@ paths: application/json: schema: description: | - A JSON object mapping configuration option names to their new values. + A JSON object, mapping configuration option names to their new values. Any omitted options will be reset to their default values or marked as unconfigured. type: object responses: