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

Actually we're going with "identity server" afterall

Browse source
This commit is contained in:
Travis Ralston 2018-08-31 15:03:48 -06:00
parent ec248b436f
commit 7ac76fa27c
32 changed files with 152 additions and 152 deletions
Download patch file Download diff file Expand all files Collapse all files

4
api/identity/associations.yaml
View file

@ -13,7 +13,7 @@
# limitations under the License.
swagger: '2.0'
info:
title: "Matrix Identity Service Establishing Associations API"
title: "Matrix Identity Server Establishing Associations API"
version: "1.0.0"
host: localhost:8090
schemes:
@ -166,7 +166,7 @@ paths:
signatures:
type: object
description: |-
The signatures of the verifying identity services which show that the
The signatures of the verifying identity servers which show that the
association should be trusted, if you trust the verifying identity
services.
$ref: "../../schemas/server-signatures.yaml"

2
api/identity/definitions/request_email_validation.yaml
View file

@ -33,7 +33,7 @@ properties:
is a number greater than the most recent one which it has seen,
scoped to that ``email`` + ``client_secret`` pair. This is to
avoid repeatedly sending the same email in the case of request
retries between the POSTing user and the identity service.
retries between the POSTing user and the identity server.
The client should increment this value if they desire a new
email (e.g. a reminder) to be sent.
example: 1

2
api/identity/definitions/request_msisdn_validation.yaml
View file

@ -41,7 +41,7 @@ properties:
scoped to that ``country`` + ``phone_number`` + ``client_secret``
triple. This is to avoid repeatedly sending the same SMS in
the case of request retries between the POSTing user and the
identity service. The client should increment this value if
identity server. The client should increment this value if
they desire a new SMS (e.g. a reminder) to be sent.
example: 1
next_link:

6
api/identity/email_associations.yaml
View file

@ -13,7 +13,7 @@
# limitations under the License.
swagger: '2.0'
info:
title: "Matrix Identity Service Email Associations API"
title: "Matrix Identity Server Email Associations API"
version: "1.0.0"
host: localhost:8090
schemes:
@ -30,8 +30,8 @@ paths:
description: |-
Create a session for validating an email address.
The identity service will send an email containing a token. If that
token is presented to the identity service in the future, it indicates
The identity server will send an email containing a token. If that
token is presented to the identity server in the future, it indicates
that that user was able to read the email for that email address, and
so we validate ownership of the email address.

4
api/identity/invitation_signing.yaml
View file

@ -13,7 +13,7 @@
# limitations under the License.
swagger: '2.0'
info:
title: "Matrix Identity Service Ephemeral Invitation Signing API"
title: "Matrix Identity Server Ephemeral Invitation Signing API"
version: "1.0.0"
host: localhost:8090
schemes:
@ -30,7 +30,7 @@ paths:
description: |-
Sign invitation details.
The identity service will look up ``token`` which was stored in a call
The identity server will look up ``token`` which was stored in a call
to ``store-invite``, and fetch the sender of the invite.
operationId: blindlySignStuff
parameters:

4
api/identity/lookup.yaml
View file

@ -16,7 +16,7 @@
# limitations under the License.
swagger: '2.0'
info:
title: "Matrix Identity Service Lookup API"
title: "Matrix Identity Server Lookup API"
version: "1.0.0"
host: localhost:8090
schemes:
@ -86,7 +86,7 @@ paths:
description: The unix timestamp at which the association was verified.
signatures:
type: object
description: The signatures of the verifying identity services which show that the association should be trusted, if you trust the verifying identity services.
description: The signatures of the verifying identity servers which show that the association should be trusted, if you trust the verifying identity servers.
$ref: "../../schemas/server-signatures.yaml"
required:
- address

8
api/identity/phone_associations.yaml
View file

@ -13,7 +13,7 @@
# limitations under the License.
swagger: '2.0'
info:
title: "Matrix Identity Service Phone Number Associations API"
title: "Matrix Identity Server Phone Number Associations API"
version: "1.0.0"
host: localhost:8090
schemes:
@ -30,8 +30,8 @@ paths:
description: |-
Create a session for validating a phone number.
The identity service will send an SMS message containing a token. If
that token is presented to the identity service in the future, it
The identity server will send an SMS message containing a token. If
that token is presented to the identity server in the future, it
indicates that that user was able to read the SMS for that phone
number, and so we validate ownership of the phone number.
@ -62,7 +62,7 @@ paths:
- ``M_INVALID_ADDRESS``: The phone number provided was invalid.
- ``M_SEND_ERROR``: The validation SMS could not be sent.
- ``M_DESTINATION_REJECTED``: The identity service cannot deliver an
- ``M_DESTINATION_REJECTED``: The identity server cannot deliver an
SMS to the provided country or region.
examples:
application/json: {

12
api/identity/ping.yaml
View file

@ -15,7 +15,7 @@
swagger: "2.0"
info:
title: "Matrix Identity Service Ping API"
title: "Matrix Identity Server Ping API"
version: "1.0.0"
host: localhost:8090
schemes:
@ -26,19 +26,19 @@ produces:
paths:
"/api/v1":
get:
summary: Checks that an identity service is available at this API endpoint.
summary: Checks that an identity server is available at this API endpoint.
description: |-
Checks that an identity service is available at this API endpoint.
Checks that an identity server is available at this API endpoint.
To discover that an identity service is available at a specific URL,
To discover that an identity server is available at a specific URL,
this endpoint can be queried and will return an empty object.
This is primarly used for auto-discovery and health check purposes
by entities acting as a client for the identity service.
by entities acting as a client for the identity server.
operationId: ping
responses:
200:
description: An identity service is ready to serve requests.
description: An identity server is ready to serve requests.
examples:
application/json: {}
schema:

2
api/identity/pubkey.yaml
View file

@ -13,7 +13,7 @@
# limitations under the License.
swagger: '2.0'
info:
title: "Matrix Identity Service Public Key API"
title: "Matrix Identity Server Public Key API"
version: "1.0.0"
host: localhost:8090
schemes:

2
api/identity/store_invite.yaml
View file

@ -13,7 +13,7 @@
# limitations under the License.
swagger: '2.0'
info:
title: "Matrix Identity Service Store Invitations API"
title: "Matrix Identity Server Store Invitations API"
version: "1.0.0"
host: localhost:8090
schemes: