Bug 1569033
Summary: | [RFE] Add json request and response examples to API documentation | ||
---|---|---|---|
Product: | OpenShift Container Platform | Reporter: | Chad Scribner <cscribne> |
Component: | Documentation | Assignee: | Vikram Goyal <vigoyal> |
Status: | CLOSED DEFERRED | QA Contact: | Vikram Goyal <vigoyal> |
Severity: | low | Docs Contact: | Vikram Goyal <vigoyal> |
Priority: | low | ||
Version: | 3.7.0 | CC: | aos-bugs, jokerman, mmccomas, rpuccini, vigoyal |
Target Milestone: | --- | ||
Target Release: | --- | ||
Hardware: | Unspecified | ||
OS: | Unspecified | ||
Whiteboard: | |||
Fixed In Version: | Doc Type: | If docs needed, set a value | |
Doc Text: | Story Points: | --- | |
Clone Of: | Environment: | ||
Last Closed: | 2019-11-21 12:51:52 UTC | Type: | Bug |
Regression: | --- | Mount Type: | --- |
Documentation: | --- | CRM: | |
Verified Versions: | Category: | --- | |
oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
Cloudforms Team: | --- | Target Upstream Version: | |
Embargoed: |
Description
Chad Scribner
2018-04-18 14:07:24 UTC
Any updates/thoughts on this one? JSON tends to be the universal API lingua franca so having this in the documentation would greatly ease adoption and prevent the need to get the data via oc or some other mechanism. (In reply to Chad Scribner from comment #2) > Any updates/thoughts on this one? JSON tends to be the universal API lingua > franca so having this in the documentation would greatly ease adoption and > prevent the need to get the data via oc or some other mechanism. Hey Chad - sorry for the delay. There is a plan to have an api.openshift.com website to host this kind of information, but other priorities have pushed that one down the line. Do you know of any other customers who may be asking for this that help us prioritise it? (In reply to Vikram Goyal from comment #3) > Do you know of any other customers who may be asking for this that help us > prioritise it? Hi Vikram -- I'm working on getting more customers on board with this. Thanks for the update! Hi Vikram -- has there been any progress or are there any updates on api.openshift.com? Sorry Chad - none at this stage. What would help is if we could have some more TAMs chime in with a request for this that would help us prioritise this over other things. If you know someone whose customer may benefit from this, please ask them to chime in on this thread. I am also exploring if we can downsize the request to exactly what you had asked for - examples, instead of the full blown api.openshift.com, but yeah - the more customers/TAMs ask for it, the better. Hi Vikram -- just wanted to check in to see if any new updates are available on this; do you have anything that you can relay? OCP 3.6-3.10 is no longer on full support [1]. Marking un-triaged bugs CLOSED DEFERRED. If you have a customer case with a support exception or have reproduced on 3.11+, please reopen and include those details. When reopening, please set the Version to the appropriate version where reproduced. [1]: https://access.redhat.com/support/policy/updates/openshift |