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

docs(jans-config-api): add json payload examples to the generated swagger #2354

Closed
2 tasks done
moabu opened this issue Sep 12, 2022 · 1 comment · Fixed by #2747
Closed
2 tasks done

docs(jans-config-api): add json payload examples to the generated swagger #2354

moabu opened this issue Sep 12, 2022 · 1 comment · Fixed by #2747
Assignees
@pujavs
Labels
area-documentation Documentation needs to change as part of issue or PR comp-jans-config-api Component affected by issue or PR
Milestone
1.0.3

Comments

@moabu
Copy link
Member

moabu commented Sep 12, 2022

Description

The swagger documentation should include example payloads to help development and execution of calls manually or via scripting clear.

https://swagger.io/docs/specification/adding-examples/

Prepare
@moabu moabu changed the title docs(config-api): add json payload examples to the generated swagger docs(jans-config-api): add json payload examples to the generated swagger Sep 12, 2022
@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-jans-config-api Component affected by issue or PR labels Sep 12, 2022
@moabu moabu mentioned this issue Sep 12, 2022
Open
@pujavs
Copy link
Contributor

pujavs commented Sep 22, 2022

WIP

@moabu moabu added this to the 1.0.3 milestone Sep 29, 2022
@pujavs pujavs mentioned this issue Oct 27, 2022
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pujavs pujavs

Labels
area-documentation Documentation needs to change as part of issue or PR comp-jans-config-api Component affected by issue or PR
Projects
None yet
Milestone
1.0.3
Development

Successfully merging a pull request may close this issue.

docs(config-api): added json payload examples to the generated swagger JanssenProject/jans
3 participants
@pujavs @moabu @mo-auto