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

Generate swagger spec from source #20

Closed
awalias opened this issue Oct 27, 2020 · 6 comments
Closed

Generate swagger spec from source #20

awalias opened this issue Oct 27, 2020 · 6 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@awalias
Copy link
Member

awalias commented Oct 27, 2020

https://medium.com/@pedram.esmaeeli/generate-swagger-specification-from-go-source-code-648615f7b9d9

@icecream78
Copy link
Contributor

icecream78 commented Nov 14, 2020

I started doing this task by using go-swagger and this is not so easy how it was seamed. But I`ve done some work and have a question. @awalias @kiwicopple Do I need include description of /admin/* , /saml/* , /instances/* to result ? Because in README that groups aren't been covered

@kiwicopple
Copy link
Member

Do I need include description of /admin/* , /saml/* , /instances/* to result ? Because in README that groups aren't been covered

Ideally it will autogen everything - is there some manual work to enable the routes?

@icecream78
Copy link
Contributor

Every route need to be described manually and then spec will be generated according to it

@kiwicopple
Copy link
Member

I see, perhaps we start with a very small set of routes and then expand it if it seems like it's the right long-term solution?

@icecream78
Copy link
Contributor

Yeah, I agree. Initial set of routes will be the same as in REAMDE. I think that it's enough to start

@J0
Copy link
Contributor

J0 commented May 17, 2022

Hey!

Thanks for looking into the issue! Unfortunately, the Swagger spec has been de-prioritized for the moment as we don't quite have the bandwidth to maintain it. I'm going to close this for now but feel free to re-open if you have any questions or concerns.

Thanks!

@J0 J0 closed this as completed May 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants