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

add an openapi spec to design/document the api #6

Open
sonalranjit opened this issue Mar 3, 2023 · 2 comments
Open

add an openapi spec to design/document the api #6

sonalranjit opened this issue Mar 3, 2023 · 2 comments
Labels
api related to api

Comments

@sonalranjit
Copy link
Member

It would be great to have an open api doc to collaboratively design and document on an open api specification document which can be implemented when the server is ready.
@sonalranjit sonalranjit added the api related to api label Mar 3, 2023
@sonalranjit sonalranjit self-assigned this Mar 3, 2023
@Arpanio
Copy link
Collaborator

Arpanio commented Mar 3, 2023

I haven't worked on this before. Miranda seems to be quite a few commits ahead in her local repo. Maybe we should pull her in here.

@sonalranjit
Copy link
Member Author

sonalranjit commented Mar 3, 2023 •
edited
Loading

Yes she should commit her code into this repo.
We can design the api with an open-api spec before we ever start coding. The spec can be written in yaml file so it can be committed here.

https://swagger.io/docs/specification/basic-structure/
^^ if this is of interest to you, you can look into this. we can translate jim's api doc in the wiki into an open api spec.

@sonalranjit sonalranjit removed their assignment Mar 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
api related to api
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Arpanio @sonalranjit