wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Move TODO. field1, field2... -> fields...

Browse source
This commit is contained in:
user 2018-07-30 19:19:35 +01:00
parent a2e2ced03b
commit 5f8967c074
3 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

4
api/application-service/application_service.yaml
View file

@ -321,7 +321,7 @@ paths:
required: true required: true
x-example: irc x-example: irc
- in: query - in: query
name: field... name: fields...
type: string type: string
description: |- description: |-
One or more custom fields that are passed to the application One or more custom fields that are passed to the application
@ -446,4 +446,4 @@ paths:
"errcode": "COM.EXAMPLE.MYAPPSERVICE_NOT_FOUND" "errcode": "COM.EXAMPLE.MYAPPSERVICE_NOT_FOUND"
} }
schema: schema:
$ref: ../client-server/definitions/errors/error.yaml $ref: ../client-server/definitions/errors/error.yaml

3
api/client-server/third_party_lookup.yaml
View file

@ -129,9 +129,8 @@ paths:
The name of the protocol. The name of the protocol.
required: true required: true
x-example: irc x-example: irc
# TODO: Change to 'explode' after OpenAPI/Swagger v3 update
- in: query - in: query
name: field1, field2... name: fields...
type: string type: string
description: |- description: |-
One or more custom fields that are passed to the AS to help identify the user. One or more custom fields that are passed to the AS to help identify the user.

4
api/openapi_extensions.md
View file

@ -8,6 +8,8 @@ parsers should be able to take advantage of the added syntax.
## Extensible Query Parameters ## Extensible Query Parameters
<!-- TODO: Remove and change instances to 'explode' after OpenAPI/Swagger v3 update -->
If a unknown amount of query parameters can be added to a request, the `name` If a unknown amount of query parameters can be added to a request, the `name`
must be `fields...`, with the trailing ellipses representing the possibility must be `fields...`, with the trailing ellipses representing the possibility
of more fields. of more fields.
@ -18,4 +20,4 @@ Example:
- in: query - in: query
name: fields... name: fields...
type: string type: string
``` ```