[enterprise-4.3] Edit suggested in file rest_api/index.adoc #19301
Comments
|
@alanconway, I've completely redesigned this, and expect to have the result merged by the end of July at the latest. |
|
Cool! On a separate note - I'd like to generate some local docs in the logging repo to reflect the state of our current development - not intended for release, just our own convenience. I'm considering https://github.com/elastic/crd-ref-docs - any other suggestions? |
|
@alanconway, you could look at what Prometheus Operator uses, but it might be the same tool. I'm not sure. Given the enormous size of the OpenAPI file, I rolled my own tool, so I'm not familiar with the available choices. |
|
@alanconway, I've completed my latest iteration. I'm not familiar with a ClusterLogging API; What API group is that part of? The current APIs in an ordinary installation of OCP are here under API reference: https://docs.openshift.com/container-platform/4.5/rest_api/objects/index.html |
|
Group is logging.openshift.io, the YAML source is at https://github.com/openshift/cluster-logging-operator/tree/master/manifests/4.6 |
|
FYI @mburke5678 |
|
@alanconway, if it isn't in the OpenAPI spec for the standard build of OCP, I can't generate docs for it. Is this only in 4.6? This is what is exposed in 4.5: |
|
@alanconway, this also probably means it isn't visible with |
|
@alanconway, I don't see a |
|
Issues go stale after 90d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle stale |
openshift-ci-robot
added
the
lifecycle/stale
|
Stale issues rot after 30d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle rotten |
openshift-ci-robot
added
lifecycle/rotten
|
@alanconway, so, installing the Operator provides the missing APIs: So with that extra step, I could start including the logging APIs in the official API docs. @vikram-redhat fyi |
jboxman
added
branch/enterprise-4.7
and removed
lifecycle/rotten
|
@rolfedh FYI |
|
@rolfedh, so it is possible to include these APIs in the API reference docs, but as of this moment, they are not included. Because logging is an add-on, I'm not sure how to proceed. |
|
Thanks, @jboxman. I'll look into it and get back to you. |
|
Issues go stale after 90d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle stale |
openshift-ci
bot
added
the
lifecycle/stale
|
/remove-lifecycle stale |
openshift-ci
bot
removed
the
lifecycle/stale
|
/lifecycle frozen |
openshift-ci
bot
added
the
lifecycle/frozen
|
@mburke5678 Please assign @libander instead. Thanks. |
|
If the Operator isn't part of the OpenShift payload and needs to be installed day-2, it won't show up in the API docs. |
|
Nevertheless, our customers require this information. How might we provide it to them? |
Which section(s) is the issue in?
REST API reference documentation
What needs fixing?
I can't find API reference docs for the openshift logging APIs (e.g. ClusterLogging)
Places I looked:
Suggestions:
The text was updated successfully, but these errors were encountered: