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

Support swaggerapi from OpenShift #571

Merged
merged 3 commits into from
Dec 16, 2014

Conversation

smarterclayton
Copy link
Contributor

Allows us to start showing API docs. Upstream dependency is kubernetes/kubernetes#2945.

Once this lands, you can start openshift with global CORS openshift start --cors-allowed-origins=.* and then go to http://openshift3swagger-claytondev.rhcloud.com

@smarterclayton smarterclayton changed the title WIP - Support swaggerapi from OpenShift Support swaggerapi from OpenShift Dec 15, 2014
@smarterclayton smarterclayton force-pushed the support_swagger branch 2 times, most recently from 27a8d6f to 1c695c7 Compare December 15, 2014 21:36
@smarterclayton
Copy link
Contributor Author

@deads2k review please

@smarterclayton
Copy link
Contributor Author

[test]

@openshift-bot
Copy link
Contributor

@deads2k
Copy link
Contributor

deads2k commented Dec 16, 2014

As a general note, it's nice to be able to explore and try the various REST APIs that we have, but the information available is more superficial than the schemas they are replacing. I definitely see the benefit of not paying a doc tax for every change made to the schema, but is there any way to annotate our types to generate more descriptive docs? In java it would be something that had harvested javadoc or used a custom doclet tag.

Also allow swagger to be optionally enabled, so we can define our own
Exposes /swaggerapi/ which includes all of the OpenShift resources in a
registered form.
@smarterclayton
Copy link
Contributor Author

Yes, upstream has already plumbed field annotation on the schema, and more will come.

@smarterclayton
Copy link
Contributor Author

Comment addressed

@deads2k
Copy link
Contributor

deads2k commented Dec 16, 2014

LGTM

@smarterclayton
Copy link
Contributor Author

[merge]

@openshift-bot
Copy link
Contributor

Origin Merge Results: SUCCESS (https://ci.openshift.redhat.com/jenkins/job/merge_pull_requests_openshift3/538/) (Image: devenv-fedora_492)

@openshift-bot
Copy link
Contributor

Evaluated for origin up to da074d1

openshift-bot pushed a commit that referenced this pull request Dec 16, 2014
@openshift-bot openshift-bot merged commit e990b80 into openshift:master Dec 16, 2014
@smarterclayton smarterclayton deleted the support_swagger branch May 18, 2015 02:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants