Bug 1495484
Summary: | [DOCS] The API reference should list SCC in the openshift API instead of the kubernetes API | ||
---|---|---|---|
Product: | OpenShift Container Platform | Reporter: | Javier Ramirez <javier.ramirez> |
Component: | Documentation | Assignee: | Gaurav Nelson <gnelson> |
Status: | CLOSED NOTABUG | QA Contact: | Xiaoli Tian <xtian> |
Severity: | low | Docs Contact: | Vikram Goyal <vigoyal> |
Priority: | low | ||
Version: | 3.6.1 | CC: | aos-bugs, jminter, jokerman, mmccomas |
Target Milestone: | --- | ||
Target Release: | --- | ||
Hardware: | Unspecified | ||
OS: | Unspecified | ||
Whiteboard: | 3.7-release-plan | ||
Fixed In Version: | Doc Type: | If docs needed, set a value | |
Doc Text: | Story Points: | --- | |
Clone Of: | Environment: | ||
Last Closed: | 2017-10-26 01:47:23 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
Javier Ramirez
2017-09-26 07:31:09 UTC
SCCs are OpenShift objects but for some historical reason they are accessed via /api, not /oapi. They can also be accessed via /apis/security.openshift.io, which is more reasonable. It should be the case that object access via API groups will be documented correctly in 3.7, assuming that the new origin autogenerated docs will be branched. I don't think the object location in the API docs should be changed, because in this case the docs are an accurate reflection of the API (even if it's not ideal!). Adding a documentation note (i.e. updating https://github.com/openshift/origin/blob/master/pkg/security/apis/security/types.go#L17-L18) wouldn't hurt. Ping me if you need help doing this. Thanks Jim for the explanation. Looks like this one is not a docs bug then. Closing it. |