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.

Sign up for GitHub

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

Jump to bottom

Preparing an API Documentation #932

Closed
canuzdrn opened this issue Dec 1, 2023 · 2 comments
Closed

Preparing an API Documentation #932

canuzdrn opened this issue Dec 1, 2023 · 2 comments
Assignees
@canuzdrn
Labels
Priority: High Issues that require immediate attention and should be addressed as soon as possible. Status: Done Issues that have been completed. Team: Backend Issues related to backend team Type: Documentation Issues related to improving or adding documentation to the project.

Comments

@canuzdrn
Copy link
Contributor

canuzdrn commented Dec 1, 2023

Description

Although we have already a OpenAPI's Swagger documentation here, I will be preparing a detailed API documentation in order to express functionalities of endpoints that we are using throughout application.

👮‍♀️ Reviewer

Arda Kabadayı

⏰ Deadline

01.12.2023
@canuzdrn canuzdrn added Priority: High Issues that require immediate attention and should be addressed as soon as possible. Status: Assigned Issues that have been assigned to someone to work on. Type: Documentation Issues related to improving or adding documentation to the project. Team: Backend Issues related to backend team labels Dec 1, 2023
@canuzdrn canuzdrn self-assigned this Dec 1, 2023
@canuzdrn canuzdrn added Status: In Progress Issues that are currently being worked on. and removed Status: Assigned Issues that have been assigned to someone to work on. labels Dec 1, 2023
@canuzdrn
Copy link
Contributor Author

canuzdrn commented Dec 1, 2023

Prepared in detail API documentation can be seen from here.

@canuzdrn canuzdrn added Status: In Review Issues that are waiting for review and approval from others. and removed Status: In Progress Issues that are currently being worked on. labels Dec 1, 2023
@Ardakacd Ardakacd added Status: Done Issues that have been completed. and removed Status: In Review Issues that are waiting for review and approval from others. labels Dec 1, 2023
@Ardakacd
Copy link
Contributor

Ardakacd commented Dec 1, 2023

I reviewed the documentation. It seems good. So I'm closing.

@Ardakacd Ardakacd closed this as completed Dec 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@canuzdrn canuzdrn

Labels
Priority: High Issues that require immediate attention and should be addressed as soon as possible. Status: Done Issues that have been completed. Team: Backend Issues related to backend team Type: Documentation Issues related to improving or adding documentation to the project.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Ardakacd @canuzdrn