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

OpenAPI Specification #29

Open
Viiprogrammer opened this issue Jul 16, 2023 · 0 comments
Open

OpenAPI Specification #29

Viiprogrammer opened this issue Jul 16, 2023 · 0 comments

Comments

@Viiprogrammer
Copy link

Viiprogrammer commented Jul 16, 2023

В документации достаточно много бардака и не используется никакой четкий стандарт, так как судя по всему она чисто рукописная, что не имеет особого смысла при наличии готовых решений которые делают хорошую документацию, клиент на основе схемы и прочее - автоматически.

Я накидал черновой вариант, он уже рабочий и покрывает основную часть документации, однако в связи с качеством текущей, сложно описать все полностью без «метода тыка».

Из того что еще не сделано в полной мере, это:

  • Некоторые поля ответа вроде rutube
  • Немного полей в которых стоило бы добавить example: не имеют таковой
  • Не добавлена авторизация и ее эндпоинт
  • Отсутствует WS

По мере возможности она будет дополниться / обновляться до более актуального состояния (хотя бы для начала по первым двум пунктам). Я бы был рад любой помощь с этим. Для большего удобства можно было бы добавить желающих как участников в организацию на SwaggerHub.

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

No branches or pull requests

1 participant