00c6a866e2
Historical note: this was originally a series of several commits, spread out over several weeks. They have been squashed together to make `git annotate` work properly. The original commits were: * 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory * aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files * 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one * 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly * 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too * 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
62 lines
2.1 KiB
YAML
62 lines
2.1 KiB
YAML
# Copyright 2016 OpenMarket Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
title: Authentication response
|
|
description: |-
|
|
Used by servers to indicate that additional authentication information is required,
|
|
type: object
|
|
properties:
|
|
flows:
|
|
description: A list of the login flows supported by the server for this API.
|
|
title: Flow information
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
stages:
|
|
description: |-
|
|
The login type of each of the stages required to complete this
|
|
authentication flow
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: "example.type.foo"
|
|
required:
|
|
- stages
|
|
params:
|
|
type: object
|
|
description: |-
|
|
Contains any information that the client will need to know in order to
|
|
use a given type of authentication. For each login type presented,
|
|
that type may be present as a key in this dictionary. For example, the
|
|
public part of an OAuth client ID could be given here.
|
|
additionalProperties:
|
|
type: object
|
|
example:
|
|
"example.type.baz": { "example_key": "foobar" }
|
|
session:
|
|
type: string
|
|
description: |-
|
|
This is a session identifier that the client must pass back to the home
|
|
server, if one is provided, in subsequent attempts to authenticate in the
|
|
same API call.
|
|
example: "xxxxxxyz"
|
|
completed:
|
|
type: array
|
|
description: |-
|
|
A list of the stages the client has completed successfully
|
|
items:
|
|
type: string
|
|
example: "example.type.foo"
|
|
required:
|
|
- flows
|