Skip to content

Commit 7fb90dc

Browse files
authored
HTTP API: Fix misleading schema description of Foxx service re-configuration (#774)
* HTTP API: Fix misleading schema description of Foxx service re-configuration * Add comma for readability
1 parent 1f1a822 commit 7fb90dc

File tree

3 files changed

+21
-51
lines changed

3 files changed

+21
-51
lines changed

site/content/3.11/develop/http-api/foxx.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ paths:
476476
patch:
477477
operationId: updateFoxxConfiguration
478478
description: |
479-
Replaces the given service's configuration.
479+
Replaces the given service's configuration partially.
480480
481481
Returns an object mapping all configuration option names to their new values.
482482
parameters:
@@ -499,15 +499,10 @@ paths:
499499
content:
500500
application/json:
501501
schema:
502+
description: |
503+
A JSON object, mapping configuration option names to their new values.
504+
Any omitted options will be ignored.
502505
type: object
503-
required:
504-
- options
505-
properties:
506-
options:
507-
description: |
508-
A JSON object mapping configuration option names to their new values.
509-
Any omitted options will be ignored.
510-
type: object
511506
responses:
512507
'200':
513508
description: |
@@ -547,15 +542,10 @@ paths:
547542
content:
548543
application/json:
549544
schema:
545+
description: |
546+
A JSON object, mapping configuration option names to their new values.
547+
Any omitted options will be reset to their default values or marked as unconfigured.
550548
type: object
551-
required:
552-
- options
553-
properties:
554-
options:
555-
description: |
556-
A JSON object mapping configuration option names to their new values.
557-
Any omitted options will be reset to their default values or marked as unconfigured.
558-
type: object
559549
responses:
560550
'200':
561551
description: |

site/content/3.12/develop/http-api/foxx.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ paths:
476476
patch:
477477
operationId: updateFoxxConfiguration
478478
description: |
479-
Replaces the given service's configuration.
479+
Replaces the given service's configuration partially.
480480
481481
Returns an object mapping all configuration option names to their new values.
482482
parameters:
@@ -499,15 +499,10 @@ paths:
499499
content:
500500
application/json:
501501
schema:
502+
description: |
503+
A JSON object, mapping configuration option names to their new values.
504+
Any omitted options will be ignored.
502505
type: object
503-
required:
504-
- options
505-
properties:
506-
options:
507-
description: |
508-
A JSON object mapping configuration option names to their new values.
509-
Any omitted options will be ignored.
510-
type: object
511506
responses:
512507
'200':
513508
description: |
@@ -547,15 +542,10 @@ paths:
547542
content:
548543
application/json:
549544
schema:
545+
description: |
546+
A JSON object, mapping configuration option names to their new values.
547+
Any omitted options will be reset to their default values or marked as unconfigured.
550548
type: object
551-
required:
552-
- options
553-
properties:
554-
options:
555-
description: |
556-
A JSON object mapping configuration option names to their new values.
557-
Any omitted options will be reset to their default values or marked as unconfigured.
558-
type: object
559549
responses:
560550
'200':
561551
description: |

site/content/3.13/develop/http-api/foxx.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ paths:
476476
patch:
477477
operationId: updateFoxxConfiguration
478478
description: |
479-
Replaces the given service's configuration.
479+
Replaces the given service's configuration partially.
480480
481481
Returns an object mapping all configuration option names to their new values.
482482
parameters:
@@ -499,15 +499,10 @@ paths:
499499
content:
500500
application/json:
501501
schema:
502+
description: |
503+
A JSON object, mapping configuration option names to their new values.
504+
Any omitted options will be ignored.
502505
type: object
503-
required:
504-
- options
505-
properties:
506-
options:
507-
description: |
508-
A JSON object mapping configuration option names to their new values.
509-
Any omitted options will be ignored.
510-
type: object
511506
responses:
512507
'200':
513508
description: |
@@ -547,15 +542,10 @@ paths:
547542
content:
548543
application/json:
549544
schema:
545+
description: |
546+
A JSON object, mapping configuration option names to their new values.
547+
Any omitted options will be reset to their default values or marked as unconfigured.
550548
type: object
551-
required:
552-
- options
553-
properties:
554-
options:
555-
description: |
556-
A JSON object mapping configuration option names to their new values.
557-
Any omitted options will be reset to their default values or marked as unconfigured.
558-
type: object
559549
responses:
560550
'200':
561551
description: |

0 commit comments

Comments
 (0)