Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-8801

REST API documentation minor issues

XMLWordPrintable

    • Moderate
    • None
    • Unspecified
    • If docs needed, set a value

      Reviewing in the API documentation, there's a number of smaller issues that should be addressed:

      • Top level specification fields have a dot prefix, nested fields don't

      https://docs.openshift.com/container-platform/4.5/rest_api/operator_apis/etcd-operator-openshift-io-v1.html#specification

      shows .apiVersion but the field name is apiVersion. Sub objects do not.

      • about page types should be linked to their individual pages

      https://docs.openshift.com/container-platform/4.5/rest_api/operator_apis/operator-apis-index.html#etcd-operator-openshift-iov1 should link to https://docs.openshift.com/container-platform/4.5/rest_api/operator_apis/etcd-operator-openshift-io-v1.html#specification

      • type sections in objects should have anchor tags so that other sections can link to them

      the spec section on this page https://docs.openshift.com/container-platform/4.5/rest_api/operator_apis/etcd-operator-openshift-io-v1.html#specification should be an anchor link

      • spec and status types in top level objects should link to the subsection type

      spec here https://docs.openshift.com/container-platform/4.5/rest_api/operator_apis/etcd-operator-openshift-io-v1.html#specification should have the type column link to the anchor tag for the spec object

              lmurthy Latha Sreenivasa Murthy
              openshift_jira_bot OpenShift Jira Bot
              Red Hat Employee
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: