feat: add microshift rest api docs

Signed-off-by: ehila <[email protected]>

upkeep: removed redundant distros label from topics and small reorder

Signed-off-by: ehila <[email protected]>

feat: add microshift_rest_api ignore similar to rest_api ignore

since microshit_rest_api is similar to rest_api except with limited APIs, updated continue statement to include that as well

Signed-off-by: ehila <[email protected]>

fix: updated rest api docs to include links

Signed-off-by: ehila <[email protected]>

fix: empty title links

Signed-off-by: ehila <[email protected]>

Author: eggfoobar

_topic_maps/_topic_map_ms.yml

@@ -88,16 +88,275 @@ Topics:
   File: understanding-api-support-tiers
 - Name: API compatibility guidelines
   File: understanding-compatibility-guidelines
+- Name: API index
+  File: index
+- Name: API object reference
+  Dir: objects
+  Topics:
+  - Name: API objects reference
+    File: index
+- Name: Extension APIs
+  Dir: api_extensions_apis
+  Topics:
+  - Name: Extension APIs
+    File: api-extensions-apis-index
+  - Name: CustomResourceDefinition [apiextensions.k8s.io/v1]
+    File: customresourcedefinition-apiextensions-k8s-io-v1
+- Name: Registration APIs
+  Dir: api_registration_apis
+  Topics:
+  - Name: Registration APIs
+    File: api-registration-apis-index
+  - Name: APIService [apiregistration.k8s.io/v1]
+    File: apiservice-apiregistration-k8s-io-v1
+- Name: Apps APIs
+  Dir: apps_apis
+  Topics:
+  - Name: Apps APIs
+    File: apps-apis-index
+  - Name: ControllerRevision [apps/v1]
+    File: controllerrevision-apps-v1
+  - Name: DaemonSet [apps/v1]
+    File: daemonset-apps-v1
+  - Name: Deployment [apps/v1]
+    File: deployment-apps-v1
+  - Name: ReplicaSet [apps/v1]
+    File: replicaset-apps-v1
+  - Name: StatefulSet [apps/v1]
+    File: statefulset-apps-v1
+- Name: Authentication APIs
+  Dir: authentication_apis
+  Topics:
+  - Name: Authentication APIs
+    File: authentication-apis-index
+  - Name: TokenRequest [authentication.k8s.io/v1]
+    File: tokenrequest-authentication-k8s-io-v1
+  - Name: TokenReview [authentication.k8s.io/v1]
+    File: tokenreview-authentication-k8s-io-v1
+- Name: Authorization APIs
+  Dir: authorization_apis
+  Topics:
+  - Name: Authorization APIs
+    File: authorization-apis-index
+  - Name: LocalSubjectAccessReview [authorization.k8s.io/v1]
+    File: localsubjectaccessreview-authorization-k8s-io-v1
+  - Name: SelfSubjectAccessReview [authorization.k8s.io/v1]
+    File: selfsubjectaccessreview-authorization-k8s-io-v1
+  - Name: SelfSubjectRulesReview [authorization.k8s.io/v1]
+    File: selfsubjectrulesreview-authorization-k8s-io-v1
+  - Name: SubjectAccessReview [authorization.k8s.io/v1]
+    File: subjectaccessreview-authorization-k8s-io-v1
+- Name: Autoscaling APIs
+  Dir: autoscaling_apis
+  Topics:
+  - Name: Autoscaling APIs
+    File: autoscaling-apis-index
+  - Name: HorizontalPodAutoscaler [autoscaling/v2]
+    File: horizontalpodautoscaler-autoscaling-v2
+  - Name: Scale [autoscaling/v1]
+    File: scale-autoscaling-v1
+- Name: Batch APIs
+  Dir: batch_apis
+  Topics:
+  - Name: Batch APIs
+    File: batch-apis-index
+  - Name: CronJob [batch/v1]
+    File: cronjob-batch-v1
+  - Name: Job [batch/v1]
+    File: job-batch-v1
+- Name: Certificates APIs
+  Dir: certificates_apis
+  Topics:
+  - Name: Certificates APIs
+    File: certificates-apis-index
+  - Name: CertificateSigningRequest [certificates.k8s.io/v1]
+    File: certificatesigningrequest-certificates-k8s-io-v1
+- Name: Coordination APIs
+  Dir: coordination_apis
+  Topics:
+  - Name: Coordination APIs
+    File: coordination-apis-index
+  - Name: Lease [coordination.k8s.io/v1]
+    File: lease-coordination-k8s-io-v1
+- Name: Core APIs
+  Dir: core_apis
+  Topics:
+  - Name: Core APIs
+    File: core-apis-index
+  - Name: Binding [v1]
+    File: binding-v1
+  - Name: ComponentStatus [v1]
+    File: componentstatus-v1
+  - Name: ConfigMap [v1]
+    File: configmap-v1
+  - Name: Endpoints [v1]
+    File: endpoints-v1
+  - Name: Event [v1]
+    File: event-v1
+  - Name: LimitRange [v1]
+    File: limitrange-v1
+  - Name: Namespace [v1]
+    File: namespace-v1
+  - Name: Node [v1]
+    File: node-v1
+  - Name: PersistentVolume [v1]
+    File: persistentvolume-v1
+  - Name: PersistentVolumeClaim [v1]
+    File: persistentvolumeclaim-v1
+  - Name: Pod [v1]
+    File: pod-v1
+  - Name: PodTemplate [v1]
+    File: podtemplate-v1
+  - Name: ReplicationController [v1]
+    File: replicationcontroller-v1
+  - Name: ResourceQuota [v1]
+    File: resourcequota-v1
+  - Name: Secret [v1]
+    File: secret-v1
+  - Name: Service [v1]
+    File: service-v1
+  - Name: ServiceAccount [v1]
+    File: serviceaccount-v1
+- Name: Discovery APIs
+  Dir: discovery_apis
+  Topics:
+  - Name: Discovery APIs
+    File: discovery-apis-index
+  - Name: EndpointSlice [discovery.k8s.io/v1]
+    File: endpointslice-discovery-k8s-io-v1
+- Name: Events APIs
+  Dir: events_apis
+  Topics:
+  - Name: Events APIs
+    File: events-apis-index
+  - Name: Event [events.k8s.io/v1]
+    File: event-events-k8s-io-v1
+- Name: Flow Control APIs
+  Dir: flow_control_apis
+  Topics:
+  - Name: Flow Control APIs
+    File: flow-control-apis-index
+  - Name: FlowSchema [flowcontrol.apiserver.k8s.io/v1beta3]
+    File: flowschema-flowcontrol-apiserver-k8s-io-v1beta3
+  - Name: PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1beta3]
+    File: prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta3
+- Name: Networking APIs
+  Dir: networking_apis
+  Topics:
+  - Name: Networking APIs
+    File: networking-apis-index
+  - Name: Ingress [networking.k8s.io/v1]
+    File: ingress-networking-k8s-io-v1
+  - Name: IngressClass [networking.k8s.io/v1]
+    File: ingressclass-networking-k8s-io-v1
+  - Name: NetworkPolicy [networking.k8s.io/v1]
+    File: networkpolicy-networking-k8s-io-v1
+- Name: Node APIs
+  Dir: node_apis
+  Topics:
+  - Name: Node APIs
+    File: node-apis-index
+  - Name: RuntimeClass [node.k8s.io/v1]
+    File: runtimeclass-node-k8s-io-v1
+- Name: Policy APIs
+  Dir: policy_apis
+  Topics:
+  - Name: Policy APIs
+    File: policy-apis-index
+  - Name: Eviction [policy/v1]
+    File: eviction-policy-v1
+  - Name: PodDisruptionBudget [policy/v1]
+    File: poddisruptionbudget-policy-v1
+- Name: RBAC APIs
+  Dir: rbac_apis
+  Topics:
+  - Name: RBAC APIs
+    File: rbac-apis-index
+  - Name: ClusterRole [rbac.authorization.k8s.io/v1]
+    File: clusterrole-rbac-authorization-k8s-io-v1
+  - Name: ClusterRoleBinding [rbac.authorization.k8s.io/v1]
+    File: clusterrolebinding-rbac-authorization-k8s-io-v1
+  - Name: Role [rbac.authorization.k8s.io/v1]
+    File: role-rbac-authorization-k8s-io-v1
+  - Name: RoleBinding [rbac.authorization.k8s.io/v1]
+    File: rolebinding-rbac-authorization-k8s-io-v1
 - Name: Network APIs
   Dir: network_apis
   Topics:
+  - Name: Network APIs
+    File: network-apis-index
   - Name: Route [route.openshift.io/v1]
     File: route-route-openshift-io-v1
+- Name: Scheduling APIs
+  Dir: scheduling_apis
+  Topics:
+  - Name: Scheduling APIs
+    File: scheduling-apis-index
+  - Name: PriorityClass [scheduling.k8s.io/v1]
+    File: priorityclass-scheduling-k8s-io-v1
 - Name: Security APIs
   Dir: security_apis
   Topics:
+  - Name: Security APIs
+    File: security-apis-index
   - Name: SecurityContextConstraints [security.openshift.io/v1]
     File: securitycontextconstraints-security-openshift-io-v1
+- Name: Security-Internal APIs
+  Dir: security_internal_apis
+  Topics:
+  - Name: Security Internal APIs
+    File: security-internal-apis-index
+  - Name: RangeAllocation [security.internal.openshift.io/v1]
+    File: rangeallocation-security-internal-openshift-io-v1
+- Name: Snapshot APIs
+  Dir: snapshot_apis
+  Topics:
+  - Name: CSI Snapshot APIs
+    File: snapshot-apis-index
+  - Name: VolumeSnapshot [snapshot.storage.k8s.io/v1]
+    File: volumesnapshot-snapshot-storage-k8s-io-v1
+  - Name: VolumeSnapshotClass [snapshot.storage.k8s.io/v1]
+    File: volumesnapshotclass-snapshot-storage-k8s-io-v1
+  - Name: VolumeSnapshotContent [snapshot.storage.k8s.io/v1]
+    File: volumesnapshotcontent-snapshot-storage-k8s-io-v1
+- Name: Storage APIs
+  Dir: storage_apis
+  Topics:
+  - Name: Storage APIs
+    File: storage-apis-index
+  - Name: CSIDriver [storage.k8s.io/v1]
+    File: csidriver-storage-k8s-io-v1
+  - Name: CSINode [storage.k8s.io/v1]
+    File: csinode-storage-k8s-io-v1
+  - Name: CSIStorageCapacity [storage.k8s.io/v1]
+    File: csistoragecapacity-storage-k8s-io-v1
+  - Name: StorageClass [storage.k8s.io/v1]
+    File: storageclass-storage-k8s-io-v1
+  - Name: VolumeAttachment [storage.k8s.io/v1]
+    File: volumeattachment-storage-k8s-io-v1
+- Name: Storage Version Migration APIs
+  Dir: storage_version_migration_apis
+  Topics:
+  - Name: Storage Version Migration APIs
+    File: storage-version-migration-apis-index
+  - Name: StorageVersionMigration [migration.k8s.io/v1alpha1]
+    File: storageversionmigration-migration-k8s-io-v1alpha1
+- Name: TopoLVM APIs
+  Dir: topolvm_apis
+  Topics:
+  - Name: TopoLVM APIs
+    File: topolvm-apis-index
+  - Name: LogicalVolume [topolvm.io/v1]
+    File: logicalvolume-topolvm-io-v1
+- Name: Webhook APIs
+  Dir: webhook_apis
+  Topics:
+  - Name: Webhook APIs
+    File: webhook-apis-index
+  - Name: MutatingWebhookConfiguration [admissionregistration.k8s.io/v1]
+    File: mutatingwebhookconfiguration-admissionregistration-k8s-io-v1
+  - Name: ValidatingWebhookConfiguration [admissionregistration.k8s.io/v1]
+    File: validatingwebhookconfiguration-admissionregistration-k8s-io-v1
 ---
 Name: CLI tools
 Dir: microshift_cli_ref

microshift_rest_api/api_extensions_apis/api-extensions-apis-index.adoc

@@ -0,0 +1,20 @@
+// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
+:_content-type: ASSEMBLY
+[id="api-extensions-apis"]
+= API Extensions APIs
+:toc: macro
+:toc-title:
+
+toc::[]
+
+== CustomResourceDefinition [apiextensions.k8s.io/v1]
+
+Description::
++
+--
+CustomResourceDefinition represents a resource that should be exposed on the API server.  Its name MUST be in the format <.spec.name>.<.spec.group>.
+--
+
+Type::
+  `object`
+