Fix enum types in JSON schemas (#1634)

`type: enum` does not exist, as an enum can be of any type.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2023-09-27 14:29:14 +02:00 committed by GitHub
parent f11c5600a2
commit 5672bdbab7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 10 additions and 16 deletions

View file

@ -0,0 +1 @@
Fix enum types in JSON schemas.

View file

@ -15,7 +15,7 @@ type: object
title: m.login.sso flow schema title: m.login.sso flow schema
properties: properties:
type: type:
type: enum type: string
enum: ["m.login.sso"] enum: ["m.login.sso"]
description: The string `m.login.sso` description: The string `m.login.sso`
example: "m.login.sso" example: "m.login.sso"

View file

@ -31,7 +31,7 @@ allOf:
- type: object - type: object
properties: properties:
edu_type: edu_type:
type: enum type: string
enum: ['m.device_list_update'] enum: ['m.device_list_update']
description: The string `m.device_list_update`. description: The string `m.device_list_update`.
example: "m.device_list_update" example: "m.device_list_update"

View file

@ -23,7 +23,7 @@ allOf:
- type: object - type: object
properties: properties:
edu_type: edu_type:
type: enum type: string
enum: ['m.direct_to_device'] enum: ['m.direct_to_device']
description: The string `m.direct_to_device`. description: The string `m.direct_to_device`.
example: "m.direct_to_device" example: "m.direct_to_device"

View file

@ -21,7 +21,7 @@ allOf:
- type: object - type: object
properties: properties:
edu_type: edu_type:
type: enum type: string
enum: ['m.presence'] enum: ['m.presence']
description: The string `m.presence` description: The string `m.presence`
example: "m.presence" example: "m.presence"
@ -44,7 +44,7 @@ allOf:
description: The user ID this presence EDU is for. description: The user ID this presence EDU is for.
example: "@john:matrix.org" example: "@john:matrix.org"
presence: presence:
type: enum type: string
enum: ['offline', 'unavailable', 'online'] enum: ['offline', 'unavailable', 'online']
description: The presence of the user. description: The presence of the user.
example: "online" example: "online"

View file

@ -24,7 +24,7 @@ allOf:
- type: object - type: object
properties: properties:
edu_type: edu_type:
type: enum type: string
enum: ['m.receipt'] enum: ['m.receipt']
description: The string `m.receipt` description: The string `m.receipt`
example: "m.receipt" example: "m.receipt"

View file

@ -23,7 +23,7 @@ allOf:
- type: object - type: object
properties: properties:
edu_type: edu_type:
type: enum type: string
enum: ['m.signing_key_update'] enum: ['m.signing_key_update']
description: The string `m.signing_update`. description: The string `m.signing_update`.
example: "m.signing_key_update" example: "m.signing_key_update"

View file

@ -20,7 +20,7 @@ allOf:
- type: object - type: object
properties: properties:
edu_type: edu_type:
type: enum type: string
enum: ['m.typing'] enum: ['m.typing']
description: The string `m.typing` description: The string `m.typing`
example: "m.typing" example: "m.typing"

View file

@ -53,13 +53,6 @@
{{ $type = delimit (slice "[" $inner_type "]") "" }} {{ $type = delimit (slice "[" $inner_type "]") "" }}
{{ end }} {{ end }}
{{/*
If the property is an enum, indicate this.
*/}}
{{ if (and (eq $property.type "string") ($property.enum)) }}
{{ $type = "enum" }}
{{ end }}
{{/* {{/*
Handle two ways of indicating "required", one for simple parameters, Handle two ways of indicating "required", one for simple parameters,
the other for request and response body objects. the other for request and response body objects.
@ -72,7 +65,7 @@
<td> <td>
{{ if $required }}<strong>Required: </strong>{{end -}} {{ if $required }}<strong>Required: </strong>{{end -}}
{{ $property.description | markdownify -}} {{ $property.description | markdownify -}}
{{ if eq $type "enum"}}<p>One of: <code>[{{ delimit $property.enum ", " }}]</code>.</p>{{ end -}} {{ if $property.enum }}<p>One of: <code>[{{ delimit $property.enum ", " }}]</code>.</p>{{ end -}}
{{ if (index $property "x-addedInMatrixVersion") }}{{ partial "added-in" (dict "v" (index $property "x-addedInMatrixVersion")) }}{{ end -}} {{ if (index $property "x-addedInMatrixVersion") }}{{ partial "added-in" (dict "v" (index $property "x-addedInMatrixVersion")) }}{{ end -}}
{{ if (index $property "x-changedInMatrixVersion") }}{{ partial "changed-in" (dict "changes_dict" (index $property "x-changedInMatrixVersion")) }}{{ end -}} {{ if (index $property "x-changedInMatrixVersion") }}{{ partial "changed-in" (dict "changes_dict" (index $property "x-changedInMatrixVersion")) }}{{ end -}}
</td> </td>