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 all commits
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
57 changes: 57 additions & 0 deletions api-admin/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,21 @@ paths:
500:
description: Something went wrong

"/applications.remove":
post:
operationId: applicationsRemove
tags: [ Applications ]
description: Remove application request
requestBody:
$ref: "#/components/requestBodies/ApplicationsRemove"
responses:
200:
$ref: "#/components/responses/ApplicationsRemoveSuccess"
400:
$ref: "#/components/responses/ApplicationsRemoveFailure"
500:
description: Something went wrong

components:
responses:
ApplicationsUserAddSuccess:
Expand Down Expand Up @@ -148,7 +163,49 @@ components:
- application_not_found
- user_not_found

ApplicationsRemoveSuccess:
description: Applicatoion was deleted.
Copy link
Collaborator

Choose a reason for hiding this comment

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

typo

content:
application/json:
schema:
type: object

ApplicationsRemoveFailure:
description:
Happens when something went wrong after attemp to remove application
content:
application/json:
schema:
required:
- code
properties:
code:
description: |
Possible errors: <br/>
`access_denied` — This error occures when user's session was expired | user doesn't have enough permission | or user unauthorized.<br/>
`invalid_request` — Something was wrong with user request.<br/>
`application_not_found` — Occure when application_id was not found.<br/>
type: string
enum:
- access_denied
- invalid_request
- application_not_found

requestBodies:
ApplicationsRemove:
required: true
content:
application/json:
schema:
required:
- applicationId
properties:
applicationId:
description: The identifier of your app.
type: string
format: uuid
example: 41190cee-5231-4dcc-8167-ebf798b55ce3

ApplicationsUserAdd:
required: true
content:
Expand Down