Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(api-admin): add remove app metod | openapi docs #40

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions api-admin/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,21 @@ paths:
500:
description: Something goes wrong

"/applications/app.remove":
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"/applications/app.remove":
"/applications.remove":

post:
operationId: applicationsAppRemove
tags: [ Applications ]
description: Create new app request
requestBody:
$ref: "#/components/requestBodies/ApplicationAppRemove"
responses:
200:
$ref: "#/components/responses/ApplicationAppRemoveDone"
400:
$ref: "#/components/responses/ApplicationAppRemoveFailure"
500:
description: Something went wrong

components:
responses:
OAuthAuthorizeDone:
Expand Down Expand Up @@ -91,7 +106,55 @@ components:
The client will be using this to associate this response with the initial request.
type: string

ApplicationAppRemoveDone:
description: App was deleted.
content:
application/json:
schema:
required:
- success
properties:
success:
type: boolean

ApplicationAppRemoveFailure:
description:
There are two different kinds of errors to handle. The first kind of error is when the developer did something wrong when creating the request.
<br/>
If there is something wrong with the syntax of the request
content:
application/json:
schema:
required:
- error
properties:
code:
description: |
Possible errors: <br/>
`invalid_request` — The request is missing a required parameter, includes an invalid parameter value, or is otherwise malformed.<br/>
`temporarily_unavailable` — The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.<br/>
type: string
enum:
- invalid_request
- temporarily_unavailable
- unauthenticated_user
- unauthorized_client

requestBodies:
ApplicationAppRemove:
required: true
content:
application/json:
schema:
required:
- appId
properties:
appId:
description: The appId is the unique identifier of your new app.
type: string
format: uuid
example: 41190cee-5231-4dcc-8167-ebf798b55ce3

OAuthAuthorize:
required: true
content:
Expand Down