Skip to content

Commit 23e7880

Browse files
committed
update permission headers to allow explicit null
use enum instead of boolean for explicit serialisation
1 parent ed18272 commit 23e7880

4 files changed

Lines changed: 16 additions & 8 deletions

File tree

openapi/vosi/vosi-auth-read.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# request header
22
name: x-vosi-auth-read
33
in: header
4-
description: flag indicating that the resource cannot be read with an anonymous request
4+
description: flag indicating that the resource requires authentication to read
55
required: false
66
schema:
7-
type: boolean
7+
type: string
8+
enum: ["true", "false", "null"]
89

openapi/vosi/vosi-group-read.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# request header
22
name: x-vosi-group-read
33
in: header
4-
description: a GMS group identifier indicating a group with read permission
4+
description: a GMS group identifier indicating a group with read permission, or literal null
55
required: false
66
schema:
7-
type: string
7+
oneOf:
8+
- type: string
9+
format: uri
10+
- type: "null"

openapi/vosi/vosi-group-write.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# request header
22
name: x-vosi-group-write
33
in: header
4-
description: a GMS group identifier indicating a group with write permission
4+
description: a GMS group identifier indicating a group with write permission, or literal null
55
required: false
66
schema:
7-
type: string
7+
oneOf:
8+
- type: string
9+
format: uri
10+
- type: "null"

openapi/vosi/vosi-table.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,10 +122,11 @@ components:
122122
description: metadata for the specified schema or table
123123
headers:
124124
x-vosi-auth-read:
125-
description: flag indicating that the resource allows anonymous read
125+
description: flag indicating that the resource requires authentication to read
126126
required: false
127127
schema:
128-
type: boolean
128+
type: string
129+
enum: ["true", "false"]
129130
x-vosi-group-read:
130131
description: a GMS group identifier indicating a group with read permission
131132
required: false

0 commit comments

Comments
 (0)