Skip to content

Commit 33d8cdd

Browse files
authored
Merge pull request #94478 from kalexand-rh/4.19apifixes
fixing api docs errors
2 parents 6d564ff + f2785e6 commit 33d8cdd

16 files changed

+239
-239
lines changed

microshift_rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ Required::
7272

7373
| `allowedUnsafeSysctls`
7474
| ``
75-
| AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection.
76-
Examples: e.g. "foo/*" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc.
75+
| AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "\*" in which case it is considered as a prefix of allowed sysctls. Single \* means all unsafe sysctls are allowed. Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection.
76+
Examples: e.g. "foo/\*" allows "foo/bar", "foo/baz", etc. e.g. "foo.\*" allows "foo.bar", "foo.baz", etc.
7777

7878
| `apiVersion`
7979
| `string`
@@ -89,7 +89,7 @@ Required::
8989

9090
| `forbiddenSysctls`
9191
| ``
92-
| ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden.
92+
| ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "\*" in which case it is considered as a prefix of forbidden sysctls. Single \* means all sysctls are forbidden.
9393
Examples: e.g. "foo/*" forbids "foo/bar", "foo/baz", etc. e.g. "foo.*" forbids "foo.bar", "foo.baz", etc.
9494

9595
| `fsGroup`

rest_api/image_apis/imagestreamimport-image-openshift-io-v1.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Required::
138138
| 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.
139139

140140
| `to`
141-
| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`]
141+
| `LocalObjectReference_v2`
142142
| 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
143143

144144
|===
@@ -2524,7 +2524,7 @@ Description::
25242524
| Parameter | Type | Description
25252525
| `body`
25262526
| xref:../image_apis/imagestreamimport-image-openshift-io-v1.adoc#imagestreamimport-image-openshift-io-v1[`ImageStreamImport`] schema
2527-
|
2527+
|
25282528
|===
25292529

25302530
.HTTP responses

rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ Cannot be set at the same time as `authorization`, or `basicAuth`.
371371

372372
| `params{}`
373373
| `array (string)`
374-
|
374+
|
375375

376376
| `path`
377377
| `string`
@@ -401,7 +401,7 @@ metadata labels.
401401

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

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

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

@@ -800,7 +800,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
800800

801801
| `proxyConnectHeader{}`
802802
| `array`
803-
|
803+
|
804804

805805
| `proxyConnectHeader{}[]`
806806
| `object`
@@ -1336,7 +1336,7 @@ metadata labels.
13361336

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

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

13411341
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
13421342
--
@@ -1886,7 +1886,7 @@ Description::
18861886
| Parameter | Type | Description
18871887
| `body`
18881888
| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema
1889-
|
1889+
|
18901890
|===
18911891

18921892
.HTTP responses
@@ -2019,7 +2019,7 @@ Description::
20192019
| Parameter | Type | Description
20202020
| `body`
20212021
| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema
2022-
|
2022+
|
20232023
|===
20242024

20252025
.HTTP responses

rest_api/monitoring_apis/probe-monitoring-coreos-com-v1.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
537537

538538
| `proxyConnectHeader{}`
539539
| `array`
540-
|
540+
|
541541

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

11581158
| `relabelingConfigs[]`
@@ -1201,9 +1201,9 @@ Description::
12011201
RelabelConfigs to apply to the label set of the target before it gets
12021202
scraped.
12031203
The original ingress address is available via the
1204-
`__tmp_prometheus_ingress_address` label. It can be used to customize the
1204+
`\__tmp_prometheus_ingress_address` label. It can be used to customize the
12051205
probed URL.
1206-
The original scrape job's name is available via the `__tmp_prometheus_job_name` label.
1206+
The original scrape job's name is available via the `\__tmp_prometheus_job_name` label.
12071207
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
12081208
--
12091209

@@ -1875,7 +1875,7 @@ Description::
18751875
| Parameter | Type | Description
18761876
| `body`
18771877
| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema
1878-
|
1878+
|
18791879
|===
18801880

18811881
.HTTP responses
@@ -2008,7 +2008,7 @@ Description::
20082008
| Parameter | Type | Description
20092009
| `body`
20102010
| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema
2011-
|
2011+
|
20122012
|===
20132013

20142014
.HTTP responses

rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -841,7 +841,7 @@ in a breaking way.
841841

842842
| `scrapeClasses[]`
843843
| `object`
844-
|
844+
|
845845

846846
| `scrapeConfigNamespaceSelector`
847847
| `object`
@@ -989,7 +989,7 @@ ServiceMonitor and ScrapeConfig resources.
989989
* The `__param_target__` label for Probe resources.
990990

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

995995
| `storage`
@@ -1027,7 +1027,7 @@ the triple <key,value,effect> using the matching operator <operator>.
10271027

10281028
| `topologySpreadConstraints[]`
10291029
| `object`
1030-
|
1030+
|
10311031

10321032
| `tracingConfig`
10331033
| `object`
@@ -3108,7 +3108,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
31083108

31093109
| `proxyConnectHeader{}`
31103110
| `array`
3111-
|
3111+
|
31123112

31133113
| `proxyConnectHeader{}[]`
31143114
| `object`
@@ -4526,7 +4526,7 @@ Type::
45264526

45274527
| `deny`
45284528
| `boolean`
4529-
|
4529+
|
45304530

45314531
|===
45324532
=== .spec.containers
@@ -10372,7 +10372,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
1037210372

1037310373
| `proxyConnectHeader{}`
1037410374
| `array`
10375-
|
10375+
|
1037610376

1037710377
| `proxyConnectHeader{}[]`
1037810378
| `object`
@@ -10646,7 +10646,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
1064610646

1064710647
| `proxyConnectHeader{}`
1064810648
| `array`
10649-
|
10649+
|
1065010650

1065110651
| `proxyConnectHeader{}[]`
1065210652
| `object`
@@ -11655,7 +11655,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
1165511655

1165611656
| `proxyConnectHeader{}`
1165711657
| `array`
11658-
|
11658+
|
1165911659

1166011660
| `proxyConnectHeader{}[]`
1166111661
| `object`
@@ -12168,7 +12168,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
1216812168

1216912169
| `proxyConnectHeader{}`
1217012170
| `array`
12171-
|
12171+
|
1217212172

1217312173
| `proxyConnectHeader{}[]`
1217412174
| `object`
@@ -13739,7 +13739,7 @@ More info: https://prometheus.io/docs/prometheus/latest/configuration/configurat
1373913739
| Relabelings configures the relabeling rules to apply to all scrape targets.
1374013740

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

@@ -13952,7 +13952,7 @@ Description::
1395213952
Relabelings configures the relabeling rules to apply to all scrape targets.
1395313953

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

@@ -21397,7 +21397,7 @@ being performed. Only delete actions will be performed.
2139721397

2139821398
| `shardStatuses[]`
2139921399
| `object`
21400-
|
21400+
|
2140121401

2140221402
| `shards`
2140321403
| `integer`
@@ -21651,7 +21651,7 @@ Description::
2165121651
| Parameter | Type | Description
2165221652
| `body`
2165321653
| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema
21654-
|
21654+
|
2165521655
|===
2165621656

2165721657
.HTTP responses
@@ -21784,7 +21784,7 @@ Description::
2178421784
| Parameter | Type | Description
2178521785
| `body`
2178621786
| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema
21787-
|
21787+
|
2178821788
|===
2178921789

2179021790
.HTTP responses
@@ -21886,7 +21886,7 @@ Description::
2188621886
| Parameter | Type | Description
2188721887
| `body`
2188821888
| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema
21889-
|
21889+
|
2189021890
|===
2189121891

2189221892
.HTTP responses
@@ -21988,7 +21988,7 @@ Description::
2198821988
| Parameter | Type | Description
2198921989
| `body`
2199021990
| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema
21991-
|
21991+
|
2199221992
|===
2199321993

2199421994
.HTTP responses

rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ Cannot be set at the same time as `authorization`, or `basicAuth`.
361361

362362
| `params{}`
363363
| `array (string)`
364-
|
364+
|
365365

366366
| `path`
367367
| `string`
@@ -387,7 +387,7 @@ metadata labels.
387387

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

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

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

@@ -784,7 +784,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
784784

785785
| `proxyConnectHeader{}`
786786
| `array`
787-
|
787+
|
788788

789789
| `proxyConnectHeader{}[]`
790790
| `object`
@@ -1320,7 +1320,7 @@ metadata labels.
13201320

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

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

13251325
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
13261326
--
@@ -1910,7 +1910,7 @@ Description::
19101910
| Parameter | Type | Description
19111911
| `body`
19121912
| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema
1913-
|
1913+
|
19141914
|===
19151915

19161916
.HTTP responses
@@ -2043,7 +2043,7 @@ Description::
20432043
| Parameter | Type | Description
20442044
| `body`
20452045
| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema
2046-
|
2046+
|
20472047
|===
20482048

20492049
.HTTP responses

0 commit comments

Comments
 (0)