Is the Openshift API swagger.json exposed anywhere?

[lholmquist]

I know there are swagger endpoint docs accessible at OPENSHIFT_URL/openapi/v2 and also OPENSHIFT_URL/swagger.json for the Kubernetes related API's.

Is there also an equivalent endpoint for the Openshift api in swagger format. I see in this repo, there is this document, https://raw.githubusercontent.com/openshift/origin/master/api/swagger-spec/openshift-openapi-spec.json, but i'm not really sure if that is exposed as an endpoint in my Openshift Cluster.

[jboxman]

@lholmquist, as near as I can tell, for release-3.11 that file is generated by this script: https://github.com/openshift/origin/blob/release-3.11/hack/update-generated-swagger-spec.sh

Out of curiosity, what were you planning on doing with spec file?

[lholmquist]

We have a Node.js module, openshift-rest-client, that we created and have been adding functionality "manually".

we are looking to refactor the library so it generates the api automatically, instead of us adding things in manually. There is a nice kubernetes node module, which does something similar. One of the ways it can load the api is querying the running clusters /openapi/v2 or /swagger.json endpoint.

If there isn't a similar endpoint for the Openshift api's, i can just use this file, which i've started to do, nodeshift/openshift-rest-client#113

[jboxman]

@lholmquist, that looks quite interesting.

My own interest in this is using the OpenShift OpenAPI specs to create REST API docs. I'll let you know if I learn anything helpful.

It does look like a running cluster is queried to generate the spec for 3.11 here:

origin/hack/update-generated-swagger-spec.sh

Line 40 in b6db8e6

oc get --raw "/swaggerapi/${type}/${endpoint}" --config="${MASTER_CONFIG_DIR}/admin.kubeconfig" > "${generated_file}"

[openshift-bot]

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[openshift-bot]

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

[openshift-bot]

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

[openshift-ci-robot]

@openshift-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.