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

Enhancement: Open API specification & improved visual documentation #1

Open
matmar10 opened this issue Oct 4, 2021 · 2 comments
Open
Assignees
Labels
enhancement New feature or request

Comments

@matmar10
Copy link

matmar10 commented Oct 4, 2021

Salaam & jazak Allah kheir for such a wonderful service. In the interest of maximizing the benefit of this service, an Open API (Swagger) spec would be very useful, and would also allow generation of client languages for virtually any language.

This is something I can contribute, but before I do I want to ensure the maintainers of this project are open to the contribution.

@meezaan
Copy link
Member

meezaan commented Oct 4, 2021

@matmar10 Alaykum Salaam and thank you for the kind words - Alhamdulillah - He makes it all possible.

Yes, an OpenAPI specification would be more than welcome.

But how are you proposing to do it - via annotations to currently replace the current apiDocJS annotations or simply write the specifications in YAML file which we can then publish?

Thank you for the offer to help.

@meezaan meezaan added the enhancement New feature or request label Oct 6, 2021
@meezaan
Copy link
Member

meezaan commented Mar 26, 2022

Will be tracked in https://github.com/islamic-network/openapi.

@meezaan meezaan transferred this issue from islamic-network/api.aladhan.com Mar 26, 2022
@BilalIshtiaque BilalIshtiaque self-assigned this Apr 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants