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 <[email protected]>
matrix-org · Sep 27, 2023 · 5672bdb · 5672bdb
1 parent f11c560
commit 5672bdb
Show file tree

Hide file tree

Showing 9 changed files with 10 additions and 16 deletions.
diff --git a/changelogs/internal/newsfragments/1634.clarification b/changelogs/internal/newsfragments/1634.clarification
@@ -0,0 +1 @@
+Fix enum types in JSON schemas.
diff --git a/data/api/client-server/definitions/sso_login_flow.yaml b/data/api/client-server/definitions/sso_login_flow.yaml
@@ -15,7 +15,7 @@ type: object
 title: m.login.sso flow schema
 properties:
   type:
-    type: enum
+    type: string
     enum: ["m.login.sso"]
     description: The string `m.login.sso`
     example: "m.login.sso"

diff --git a/data/api/server-server/definitions/event-schemas/m.device_list_update.yaml b/data/api/server-server/definitions/event-schemas/m.device_list_update.yaml
@@ -31,7 +31,7 @@ allOf:
   - type: object
     properties:
       edu_type:
-        type: enum
+        type: string
         enum: ['m.device_list_update']
         description: The string `m.device_list_update`.
         example: "m.device_list_update"

diff --git a/data/api/server-server/definitions/event-schemas/m.direct_to_device.yaml b/data/api/server-server/definitions/event-schemas/m.direct_to_device.yaml
@@ -23,7 +23,7 @@ allOf:
   - type: object
     properties:
       edu_type:
-        type: enum
+        type: string
         enum: ['m.direct_to_device']
         description: The string `m.direct_to_device`.
         example: "m.direct_to_device"

diff --git a/data/api/server-server/definitions/event-schemas/m.presence.yaml b/data/api/server-server/definitions/event-schemas/m.presence.yaml
@@ -21,7 +21,7 @@ allOf:
   - type: object
     properties:
       edu_type:
-        type: enum
+        type: string
         enum: ['m.presence']
         description: The string `m.presence`
         example: "m.presence"
@@ -44,7 +44,7 @@ allOf:
                   description: The user ID this presence EDU is for.
                   example: "@john:matrix.org"
                 presence:
-                  type: enum
+                  type: string
                   enum: ['offline', 'unavailable', 'online']
                   description: The presence of the user.
                   example: "online"

diff --git a/data/api/server-server/definitions/event-schemas/m.receipt.yaml b/data/api/server-server/definitions/event-schemas/m.receipt.yaml
@@ -24,7 +24,7 @@ allOf:
   - type: object
     properties:
       edu_type:
-        type: enum
+        type: string
         enum: ['m.receipt']
         description: The string `m.receipt`
         example: "m.receipt"

diff --git a/data/api/server-server/definitions/event-schemas/m.signing_key_update.yaml b/data/api/server-server/definitions/event-schemas/m.signing_key_update.yaml
@@ -23,7 +23,7 @@ allOf:
   - type: object
     properties:
       edu_type:
-        type: enum
+        type: string
         enum: ['m.signing_key_update']
         description: The string `m.signing_update`.
         example: "m.signing_key_update"

diff --git a/data/api/server-server/definitions/event-schemas/m.typing.yaml b/data/api/server-server/definitions/event-schemas/m.typing.yaml
@@ -20,7 +20,7 @@ allOf:
   - type: object
     properties:
       edu_type:
-        type: enum
+        type: string
         enum: ['m.typing']
         description: The string `m.typing`
         example: "m.typing"

diff --git a/layouts/partials/openapi/render-object-table.html b/layouts/partials/openapi/render-object-table.html
@@ -53,13 +53,6 @@
             {{ $type = delimit (slice "[" $inner_type "]") "" }}
         {{ 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,
           the other for request and response body objects.
@@ -72,7 +65,7 @@
   <td>
     {{ if $required }}<strong>Required: </strong>{{end -}}
     {{ $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-changedInMatrixVersion") }}{{ partial "changed-in" (dict "changes_dict" (index $property "x-changedInMatrixVersion")) }}{{ end -}}
   </td>