Skip to content

HTTP API: Fix misleading schema description of Foxx service re-configuration #774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 26, 2025
Merged

HTTP API: Fix misleading schema description of Foxx service re-configuration #774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac4e1e7
HTTP API: Fix misleading schema description of Foxx service re-config…
Simran-B Aug 21, 2025
031d913
Add comma for readability
Simran-B Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 7 additions & 17 deletions site/content/3.11/develop/http-api/foxx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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: |
Expand Down Expand Up @@ -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: |
Expand Down
24 changes: 7 additions & 17 deletions site/content/3.12/develop/http-api/foxx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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: |
Expand Down Expand Up @@ -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: |
Expand Down
24 changes: 7 additions & 17 deletions site/content/3.13/develop/http-api/foxx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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: |
Expand Down Expand Up @@ -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: |
Expand Down