Skip to content

fixing api docs errors #100776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 17, 2025
Merged

fixing api docs errors #100776

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions rest_api/image_apis/imagestreamimport-image-openshift-io-v1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Required::
| TagReferencePolicy describes how pull-specs for images in this image stream tag are generated when image change triggers in deployment configs or builds are resolved. This allows the image stream author to control how images are accessed.

| `to`
| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`]
| `LocalObjectReference_v2`
| To is a tag in the current image stream to assign the imported image to, if name is not specified the default tag from from.name will be used

|===
Expand Down Expand Up @@ -2524,7 +2524,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../image_apis/imagestreamimport-image-openshift-io-v1.adoc#imagestreamimport-image-openshift-io-v1[`ImageStreamImport`] schema
|
|
|===

.HTTP responses
Expand Down
12 changes: 6 additions & 6 deletions rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ Cannot be set at the same time as `authorization`, or `basicAuth`.

| `params{}`
| `array (string)`
|
|

| `path`
| `string`
Expand Down Expand Up @@ -436,7 +436,7 @@ metadata labels.

The Operator automatically adds relabelings for a few standard Kubernetes fields.

The original scrape job's name is available via the `__tmp_prometheus_job_name` label.
The original scrape job's name is available via the `\__tmp_prometheus_job_name` label.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Expand Down Expand Up @@ -835,7 +835,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

| `proxyConnectHeader{}`
| `array`
|
|

| `proxyConnectHeader{}[]`
| `object`
Expand Down Expand Up @@ -1436,7 +1436,7 @@ metadata labels.

The Operator automatically adds relabelings for a few standard Kubernetes fields.

The original scrape job's name is available via the `__tmp_prometheus_job_name` label.
The original scrape job's name is available via the `\__tmp_prometheus_job_name` label.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
--
Expand Down Expand Up @@ -1986,7 +1986,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema
|
|
|===

.HTTP responses
Expand Down Expand Up @@ -2119,7 +2119,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema
|
|
|===

.HTTP responses
Expand Down
14 changes: 7 additions & 7 deletions rest_api/monitoring_apis/probe-monitoring-coreos-com-v1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

| `proxyConnectHeader{}`
| `array`
|
|

| `proxyConnectHeader{}[]`
| `object`
Expand Down Expand Up @@ -1304,9 +1304,9 @@ Type::
| RelabelConfigs to apply to the label set of the target before it gets
scraped.
The original ingress address is available via the
`__tmp_prometheus_ingress_address` label. It can be used to customize the
`\__tmp_prometheus_ingress_address` label. It can be used to customize the
probed URL.
The original scrape job's name is available via the `__tmp_prometheus_job_name` label.
The original scrape job's name is available via the `\__tmp_prometheus_job_name` label.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

| `relabelingConfigs[]`
Expand Down Expand Up @@ -1355,9 +1355,9 @@ Description::
RelabelConfigs to apply to the label set of the target before it gets
scraped.
The original ingress address is available via the
`__tmp_prometheus_ingress_address` label. It can be used to customize the
`\__tmp_prometheus_ingress_address` label. It can be used to customize the
probed URL.
The original scrape job's name is available via the `__tmp_prometheus_job_name` label.
The original scrape job's name is available via the `\__tmp_prometheus_job_name` label.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
--

Expand Down Expand Up @@ -2029,7 +2029,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema
|
|
|===

.HTTP responses
Expand Down Expand Up @@ -2162,7 +2162,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema
|
|
|===

.HTTP responses
Expand Down
32 changes: 16 additions & 16 deletions rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -865,7 +865,7 @@ in a breaking way.

| `scrapeClasses[]`
| `object`
|
|

| `scrapeClassicHistograms`
| `boolean`
Expand Down Expand Up @@ -1021,7 +1021,7 @@ ServiceMonitor and ScrapeConfig resources.
* The `__param_target__` label for Probe resources.

Users can define their own sharding implementation by setting the
`__tmp_hash` label during the target discovery with relabeling
`\__tmp_hash` label during the target discovery with relabeling
configuration (either in the monitoring resources or via scrape class).

You can also disable sharding on a specific target by setting the
Expand Down Expand Up @@ -1071,7 +1071,7 @@ the triple <key,value,effect> using the matching operator <operator>.

| `topologySpreadConstraints[]`
| `object`
|
|

| `tracingConfig`
| `object`
Expand Down Expand Up @@ -3144,7 +3144,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

| `proxyConnectHeader{}`
| `array`
|
|

| `proxyConnectHeader{}[]`
| `object`
Expand Down Expand Up @@ -4660,7 +4660,7 @@ Type::

| `deny`
| `boolean`
|
|

|===
=== .spec.containers
Expand Down Expand Up @@ -10538,7 +10538,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

| `proxyConnectHeader{}`
| `array`
|
|

| `proxyConnectHeader{}[]`
| `object`
Expand Down Expand Up @@ -10812,7 +10812,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

| `proxyConnectHeader{}`
| `array`
|
|

| `proxyConnectHeader{}[]`
| `object`
Expand Down Expand Up @@ -11821,7 +11821,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

| `proxyConnectHeader{}`
| `array`
|
|

| `proxyConnectHeader{}[]`
| `object`
Expand Down Expand Up @@ -12340,7 +12340,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

| `proxyConnectHeader{}`
| `array`
|
|

| `proxyConnectHeader{}[]`
| `object`
Expand Down Expand Up @@ -13911,7 +13911,7 @@ More info: https://prometheus.io/docs/prometheus/latest/configuration/configurat
| Relabelings configures the relabeling rules to apply to all scrape targets.

The Operator automatically adds relabelings for a few standard Kubernetes fields
like `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.
like `\__meta_kubernetes_namespace` and `\__meta_kubernetes_service_name`.
Then the Operator adds the scrape class relabelings defined here.
Then the Operator adds the target-specific relabelings defined in the scrape object.

Expand Down Expand Up @@ -14124,7 +14124,7 @@ Description::
Relabelings configures the relabeling rules to apply to all scrape targets.

The Operator automatically adds relabelings for a few standard Kubernetes fields
like `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.
like `\__meta_kubernetes_namespace` and `\__meta_kubernetes_service_name`.
Then the Operator adds the scrape class relabelings defined here.
Then the Operator adds the target-specific relabelings defined in the scrape object.

Expand Down Expand Up @@ -21599,7 +21599,7 @@ being performed. Only delete actions will be performed.

| `shardStatuses[]`
| `object`
|
|

| `shards`
| `integer`
Expand Down Expand Up @@ -21853,7 +21853,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema
|
|
|===

.HTTP responses
Expand Down Expand Up @@ -21986,7 +21986,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema
|
|
|===

.HTTP responses
Expand Down Expand Up @@ -22088,7 +22088,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema
|
|
|===

.HTTP responses
Expand Down Expand Up @@ -22190,7 +22190,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema
|
|
|===

.HTTP responses
Expand Down
12 changes: 6 additions & 6 deletions rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ Cannot be set at the same time as `authorization`, or `basicAuth`.

| `params{}`
| `array (string)`
|
|

| `path`
| `string`
Expand Down Expand Up @@ -431,7 +431,7 @@ metadata labels.

The Operator automatically adds relabelings for a few standard Kubernetes fields.

The original scrape job's name is available via the `__tmp_prometheus_job_name` label.
The original scrape job's name is available via the `\__tmp_prometheus_job_name` label.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

Expand Down Expand Up @@ -828,7 +828,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

| `proxyConnectHeader{}`
| `array`
|
|

| `proxyConnectHeader{}[]`
| `object`
Expand Down Expand Up @@ -1429,7 +1429,7 @@ metadata labels.

The Operator automatically adds relabelings for a few standard Kubernetes fields.

The original scrape job's name is available via the `__tmp_prometheus_job_name` label.
The original scrape job's name is available via the `\__tmp_prometheus_job_name` label.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
--
Expand Down Expand Up @@ -2177,7 +2177,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema
|
|
|===

.HTTP responses
Expand Down Expand Up @@ -2310,7 +2310,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema
|
|
|===

.HTTP responses
Expand Down
Loading