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 add-user method description | openapi docs #37

Merged
merged 3 commits into from
Jun 26, 2021

Conversation

asvtsv
Copy link
Contributor

@asvtsv asvtsv commented Jun 24, 2021

Описание контракта для ручки Добавления пользователя в приложение. Задача -> https://linear.app/atomix/issue/ACC-61/dobavlenie-polzovatelya-v-prilozhenie

@linear
Copy link

linear bot commented Jun 24, 2021

ACC-61 Добавление пользователя в приложение

Отправляем application id, user id, возвращает успех или нет (описать варианты ошибок).

Пользователь не может зарегистрироваться в приложении дважды, но может быть зарегистрирован не входив ни разу

enum:
- access_denied
- invalid_request
- temporarily_unavailable
Copy link
Member

Choose a reason for hiding this comment

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

Для этой ошибки есть отдельный статус 500

- user_not_found
- unauthenticated_user
- unauthorized_client
redirectUri:
Copy link
Member

Choose a reason for hiding this comment

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

Лишнее поле, кажется

description: User should be redirected to if passed redirectUri and clientId is correct
type: string
format: url
state:
Copy link
Member

Choose a reason for hiding this comment

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

Это тоже лишнее

application/json:
schema:
required:
- error
Copy link
Member

Choose a reason for hiding this comment

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

Обязательное поле error, но поля такого нет, есть code

- application_not_found
- user_not_found
- unauthenticated_user
- unauthorized_client
Copy link
Member

Choose a reason for hiding this comment

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

Думаю, такой ошибки не будет

@sergeysova sergeysova merged commit 1b1ff6d into master Jun 26, 2021
@sergeysova sergeysova deleted the ACC-61 branch June 26, 2021 15:08
sergeysova pushed a commit that referenced this pull request Jul 7, 2021
docs(api-admin): fix path

docs(api-admin): fix review comments

docs(api-admin): fix review comments

docs(api-admin): fix error description

Create linear-linker.yml

docs(api-admin): add add-user method description | openapi docs (#37)

fix(api-admin): naming, remove example method

merged manually #39

Closes #39

fix

docs(api-admin): add delete user method description | openapi docs (#36)

* docs(api-admin): add delete user method description | openapi docs

* docs(api-admin): fix review comments

* docs(api-admin): fix review

* docs(api-admin): typo fixes

* docs(api-admin): fix error description

Apply suggestions from code review
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants