Skip to content
This repository has been archived by the owner on Aug 9, 2024. It is now read-only.

Improve the API documentation #29

Closed
programarivm opened this issue Dec 4, 2022 · 0 comments · Fixed by #30
Closed

Improve the API documentation #29

programarivm opened this issue Dec 4, 2022 · 0 comments · Fixed by #30
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@programarivm
Copy link
Member

The Chess API has recently been updated:

Attached below are some examples of the newest version up and running.

Figure-01
Figure 1. POST https://pchess.net/api/grandmaster

Figure-02
Figure 2. POST https://pchess.net/api/download_image

The swagger.yaml file should be proofread and updated accordingly. The API controller methods are found in the src/Controller folder.

This is the sandbox API for testing purposes:

Should you find a bug or something that needs to be upgraded, please open an issue.

Keep it up, and happy coding and learning!
@programarivm programarivm added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 4, 2022
@programarivm programarivm mentioned this issue Dec 10, 2022
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Issue/29 improve the api documentation chesslablab/chess-api
1 participant
@programarivm