OpenAPI: split User data tag
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
This commit is contained in:
parent
97ebe5aec2
commit
39e70a2902
4 changed files with 18 additions and 18 deletions
|
@ -87,7 +87,7 @@ paths:
|
||||||
associated the third party identifier with the user.
|
associated the third party identifier with the user.
|
||||||
required: ['medium', 'address', 'validated_at', 'added_at']
|
required: ['medium', 'address', 'validated_at', 'added_at']
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
post:
|
post:
|
||||||
summary: Adds contact information to the user's account.
|
summary: Adds contact information to the user's account.
|
||||||
description: |-
|
description: |-
|
||||||
|
@ -179,7 +179,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
"$ref": "definitions/errors/error.yaml"
|
"$ref": "definitions/errors/error.yaml"
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
"/account/3pid/add":
|
"/account/3pid/add":
|
||||||
post:
|
post:
|
||||||
summary: Adds contact information to the user's account.
|
summary: Adds contact information to the user's account.
|
||||||
|
@ -235,7 +235,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
"$ref": "definitions/errors/rate_limited.yaml"
|
"$ref": "definitions/errors/rate_limited.yaml"
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
"/account/3pid/bind":
|
"/account/3pid/bind":
|
||||||
post:
|
post:
|
||||||
summary: Binds a 3PID to the user's account through an Identity Service.
|
summary: Binds a 3PID to the user's account through an Identity Service.
|
||||||
|
@ -289,7 +289,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
"$ref": "definitions/errors/rate_limited.yaml"
|
"$ref": "definitions/errors/rate_limited.yaml"
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
"/account/3pid/delete":
|
"/account/3pid/delete":
|
||||||
post:
|
post:
|
||||||
summary: Deletes a third party identifier from the user's account
|
summary: Deletes a third party identifier from the user's account
|
||||||
|
@ -354,7 +354,7 @@ paths:
|
||||||
required:
|
required:
|
||||||
- id_server_unbind_result
|
- id_server_unbind_result
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
"/account/3pid/unbind":
|
"/account/3pid/unbind":
|
||||||
post:
|
post:
|
||||||
summary: Removes a user's third party identifier from an identity server.
|
summary: Removes a user's third party identifier from an identity server.
|
||||||
|
@ -418,7 +418,7 @@ paths:
|
||||||
required:
|
required:
|
||||||
- id_server_unbind_result
|
- id_server_unbind_result
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
"/account/3pid/email/requestToken":
|
"/account/3pid/email/requestToken":
|
||||||
post:
|
post:
|
||||||
summary: Begins the validation process for an email address for association with the user's account.
|
summary: Begins the validation process for an email address for association with the user's account.
|
||||||
|
@ -471,7 +471,7 @@ paths:
|
||||||
"error": "Third party identifier already in use"
|
"error": "Third party identifier already in use"
|
||||||
}
|
}
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
"/account/3pid/msisdn/requestToken":
|
"/account/3pid/msisdn/requestToken":
|
||||||
post:
|
post:
|
||||||
summary: Begins the validation process for a phone number for association with the user's account.
|
summary: Begins the validation process for a phone number for association with the user's account.
|
||||||
|
@ -521,4 +521,4 @@ paths:
|
||||||
"error": "Third party identifier already in use"
|
"error": "Third party identifier already in use"
|
||||||
}
|
}
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
|
|
|
@ -214,7 +214,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
"$ref": "definitions/errors/rate_limited.yaml"
|
"$ref": "definitions/errors/rate_limited.yaml"
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
"/register/email/requestToken":
|
"/register/email/requestToken":
|
||||||
post:
|
post:
|
||||||
summary: Begins the validation process for an email to be used during registration.
|
summary: Begins the validation process for an email to be used during registration.
|
||||||
|
@ -266,7 +266,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
"$ref": "definitions/errors/error.yaml"
|
"$ref": "definitions/errors/error.yaml"
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
"/register/msisdn/requestToken":
|
"/register/msisdn/requestToken":
|
||||||
post:
|
post:
|
||||||
summary: Requests a validation token be sent to the given phone number for the purpose of registering an account
|
summary: Requests a validation token be sent to the given phone number for the purpose of registering an account
|
||||||
|
@ -318,7 +318,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
"$ref": "definitions/errors/error.yaml"
|
"$ref": "definitions/errors/error.yaml"
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
"/account/password":
|
"/account/password":
|
||||||
post:
|
post:
|
||||||
summary: "Changes a user's password."
|
summary: "Changes a user's password."
|
||||||
|
@ -382,7 +382,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
"$ref": "definitions/errors/rate_limited.yaml"
|
"$ref": "definitions/errors/rate_limited.yaml"
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
"/account/password/email/requestToken":
|
"/account/password/email/requestToken":
|
||||||
post:
|
post:
|
||||||
summary: Requests a validation token be sent to the given email address for the purpose of resetting a user's password
|
summary: Requests a validation token be sent to the given email address for the purpose of resetting a user's password
|
||||||
|
@ -439,7 +439,7 @@ paths:
|
||||||
"error": "Email not found"
|
"error": "Email not found"
|
||||||
}
|
}
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
"/account/password/msisdn/requestToken":
|
"/account/password/msisdn/requestToken":
|
||||||
post:
|
post:
|
||||||
summary: Requests a validation token be sent to the given phone number for the purpose of resetting a user's password.
|
summary: Requests a validation token be sent to the given phone number for the purpose of resetting a user's password.
|
||||||
|
@ -496,7 +496,7 @@ paths:
|
||||||
"error": "Phone number not found"
|
"error": "Phone number not found"
|
||||||
}
|
}
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
"/account/deactivate":
|
"/account/deactivate":
|
||||||
post:
|
post:
|
||||||
summary: "Deactivate a user's account."
|
summary: "Deactivate a user's account."
|
||||||
|
@ -573,7 +573,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
"$ref": "definitions/errors/rate_limited.yaml"
|
"$ref": "definitions/errors/rate_limited.yaml"
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
"/register/available":
|
"/register/available":
|
||||||
get:
|
get:
|
||||||
summary: Checks to see if a username is available on the server.
|
summary: Checks to see if a username is available on the server.
|
||||||
|
@ -635,4 +635,4 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
"$ref": "definitions/errors/rate_limited.yaml"
|
"$ref": "definitions/errors/rate_limited.yaml"
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Account management
|
||||||
|
|
|
@ -107,4 +107,4 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
"$ref": "definitions/errors/rate_limited.yaml"
|
"$ref": "definitions/errors/rate_limited.yaml"
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- User directory
|
||||||
|
|
|
@ -89,4 +89,4 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
"$ref": "definitions/errors/rate_limited.yaml"
|
"$ref": "definitions/errors/rate_limited.yaml"
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- Session management
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue