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

do we have plan to create the API document for OCM component #129

Open
hchenxa opened this issue Feb 28, 2022 · 2 comments
Open

do we have plan to create the API document for OCM component #129

hchenxa opened this issue Feb 28, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@hchenxa
Copy link

hchenxa commented Feb 28, 2022

@qiujian16 I can not find api document for OCM component, do we have any plan to create one which will be helpful to check the resources in OCM.

may be like https://api.openshift.com/
@qiujian16
Copy link
Member

We have a concept part in website that shows some apis. I have not figured out how api doc could be published on the website yet..any ideas?

@hchenxa
Copy link
Author

hchenxa commented Feb 28, 2022

may be use the github page, I can see someone create the swagger doc on github page. like https://github.com/peter-evans/swagger-github-pages

@apphe apphe added the documentation Improvements or additions to documentation label Mar 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@qiujian16 @hchenxa @apphe