mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-23 19:44:09 +01:00
Switch from additionalProperties: {} to using a description
This commit is contained in:
parent
20c109c3a7
commit
de615f5bd7
|
|
@ -1 +1 @@
|
||||||
The `UserIdentifier` object in `POST /_matrix/client/v3/login` can contain additional properties.
|
The `UserIdentifier` object in `POST /_matrix/client/v3/login` contains additional properties that depend on the identification type.
|
||||||
|
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Enforce `additionalProperties: {}` instead of the equivalent `additionalProperties: true` for easier processing.
|
|
||||||
|
|
@ -18,7 +18,10 @@ type: object
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
type: string
|
type: string
|
||||||
description: The type of identification. See [Identifier types](/client-server-api/#identifier-types) for supported values and additional property descriptions.
|
description: |-
|
||||||
|
The type of identification. See [Identifier types](/client-server-api/#identifier-types)
|
||||||
|
for supported values and additional property descriptions.
|
||||||
required:
|
required:
|
||||||
- type
|
- type
|
||||||
additionalProperties: {}
|
additionalProperties:
|
||||||
|
description: Keys dependent on the identification type
|
||||||
|
|
|
||||||
|
|
@ -53,11 +53,6 @@
|
||||||
|
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
||||||
{{/* Enforce `additionalProperties: {}` instead of the equivalent `additionalProperties: true` for easier processing */}}
|
|
||||||
{{ if eq .additionalProperties true }}
|
|
||||||
{{ errorf "Use `additionalProperties: {}` instead of `additionalProperties: true`" }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
{{/*
|
{{/*
|
||||||
If the object has additional properties *as well as* regular properties, we add a special row to the table.
|
If the object has additional properties *as well as* regular properties, we add a special row to the table.
|
||||||
|
|
||||||
|
|
@ -72,6 +67,9 @@
|
||||||
|
|
||||||
TODO: support `patternProperties` here.
|
TODO: support `patternProperties` here.
|
||||||
*/}}
|
*/}}
|
||||||
|
{{ if eq .additionalProperties true }}
|
||||||
|
{{ errorf "`additionalProperties: true` is de facto the default for Matrix and doesn't provide any information" }}
|
||||||
|
{{ end }}
|
||||||
{{ if reflect.IsMap .additionalProperties }}
|
{{ if reflect.IsMap .additionalProperties }}
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue