Skip to content

Commit 630ecf3

Browse files
Update docs to clarify that 'Target' can be URL-Encoded.
1 parent 6ef401e commit 630ecf3

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

docs/openapi.yaml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,9 @@ paths:
336336
schema:
337337
default: "::"
338338
type: "string"
339-
- description: "Target to patch"
339+
- description: |
340+
Target to patch; this value can be URL-Encoded and *must*
341+
be URL-Encoded if it includes non-ASCII characters.
340342
in: "header"
341343
name: "Target"
342344
required: true
@@ -808,7 +810,9 @@ paths:
808810
schema:
809811
default: "::"
810812
type: "string"
811-
- description: "Target to patch"
813+
- description: |
814+
Target to patch; this value can be URL-Encoded and *must*
815+
be URL-Encoded if it includes non-ASCII characters.
812816
in: "header"
813817
name: "Target"
814818
required: true
@@ -1438,7 +1442,9 @@ paths:
14381442
schema:
14391443
default: "::"
14401444
type: "string"
1441-
- description: "Target to patch"
1445+
- description: |
1446+
Target to patch; this value can be URL-Encoded and *must*
1447+
be URL-Encoded if it includes non-ASCII characters.
14421448
in: "header"
14431449
name: "Target"
14441450
required: true

docs/src/lib/patch.jsonnet

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,10 @@
4141
{
4242
name: 'Target',
4343
'in': 'header',
44-
description: 'Target to patch',
44+
description: |||
45+
Target to patch; this value can be URL-Encoded and *must*
46+
be URL-Encoded if it includes non-ASCII characters.
47+
|||,
4548
required: true,
4649
schema: {
4750
type: 'string',

0 commit comments

Comments
 (0)