Skip to content

Commit 1652ae6

Browse files
authored
[25.2] Clean up API doc xrefs to new Bump URLs (#1311)
1 parent aeec251 commit 1652ae6

File tree

16 files changed

+32
-32
lines changed

16 files changed

+32
-32
lines changed

modules/ROOT/nav.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -255,9 +255,9 @@
255255
*** link:https://github.com/redpanda-data/helm-charts/releases[Redpanda Helm Chart^]
256256
*** link:https://github.com/redpanda-data/redpanda-operator/releases[Redpanda Operator^]
257257
** xref:reference:api-reference.adoc[]
258-
*** xref:api:ROOT:pandaproxy-rest.adoc[]
259-
*** xref:api:ROOT:pandaproxy-schema-registry.adoc[]
260-
*** xref:api:ROOT:admin-api.adoc[]
258+
*** link:/api/doc/http-proxy/[HTTP Proxy API]
259+
*** link:/api/doc/schema-registry/[Schema Registry API]
260+
*** link:/api/doc/admin/[Admin API]
261261
** xref:reference:data-transforms/sdks.adoc[]
262262
*** xref:reference:data-transforms/golang-sdk.adoc[Golang]
263263
*** xref:reference:data-transforms/rust-sdk.adoc[Rust]

modules/develop/pages/produce-data/configure-producers.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ Each time a broker receives a message with a skewed timestamp that is outside a
249249
=== Disable broker timestamp retention
250250

251251
// For cloud there must be restrictions on Admin API usage. We should find out and omit any references to unsupported endpoints.
252-
While not advised for typical use, Redpanda lets you override the use of broker timestamps for retention policy with the Admin API. Use the xref:api:ROOT:admin-api.adoc#Licenses-and-Features/operation/put_feature[`activate feature`] API to disable the `broker_time_based_retention` property.
252+
While not advised for typical use, Redpanda lets you override the use of broker timestamps for retention policy with the Admin API. Use the link:/api/doc/admin/operation/operation-put_feature[`activate feature`] API to disable the `broker_time_based_retention` property.
253253

254254
If you disable this feature, make sure to specify your desired timestamp policy. This is stored in the xref:reference:cluster-properties.adoc#log_message_timestamp_type[`log_message_timestamp_type`] cluster property. The timestamp policy defaults to `CreateTime` (client timestamp set by producer) but may be updated to `LogAppendTime` (server timestamp set by Redpanda).
255255
endif::[]

modules/manage/pages/cluster-maintenance/partition-recovery.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ NOTE: If you want to instead force recover all partitions in bulk from a set of
1313

1414
The following examples assume that partition 0 in topic `test` is unavailable and its replicas cannot form a majority to elect a leader.
1515

16-
. Call the xref:api:ROOT:admin-api.adoc#tag/Partitions/operation/get_topic_partitions[`/partitions/kafka/<topic>`] endpoint to determine the current broker and shard assignments of the partition replicas.
16+
. Call the link:/api/doc/admin/operation/operation-get_topic_partitions[`/partitions/kafka/<topic>`] endpoint to determine the current broker and shard assignments of the partition replicas.
1717
+
1818
[,bash]
1919
----
@@ -77,7 +77,7 @@ curl -X POST http://localhost:9644/v1/debug/partitions/kafka/test/0/force_replic
7777
+
7878
The request body includes the broker ID and the CPU core (shard ID) for the replica on broker 1, to hydrate the new replicas assigned to brokers 4 and 5 on cores 1 and 0 respectively.
7979
+
80-
If there are `n` CPU cores on the machine, the value of `core` can be within the range `[0, n-1]`. You may use a random value within the range, or the least loaded shard. See the xref:reference:public-metrics-reference.adoc[public metrics reference] for metrics regarding CPU usage, and xref:api:ROOT:admin-api.adoc#tag/Partitions/operation/force_update_partition_replicas[Redpanda Admin API] for additional detail.
80+
If there are `n` CPU cores on the machine, the value of `core` can be within the range `[0, n-1]`. You may use a random value within the range, or the least loaded shard. See the xref:reference:public-metrics-reference.adoc[public metrics reference] for metrics regarding CPU usage, and link:/api/doc/admin/operation/operation-force_update_partition_replicas[Redpanda Admin API] for additional detail.
8181

8282
include::shared:partial$suggested-reading.adoc[]
8383

modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Use any of the following to set `redpanda.iceberg.mode`:
142142
+
143143
* `rpk`. See the following examples to run `rpk topic` commands.
144144
* The Cloud UI. Navigate to *Topics* to create a new topic and specify `redpanda.iceberg.mode` in *Additional Configuration*, or edit an existing topic under the topic's *Configuration* tab.
145-
* The Data Plane API to xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1/topics[create a new topic] or xref:api:ROOT:cloud-dataplane-api.adoc#patch-/v1/topics/-topic_name-/configurations[update a property for an existing topic]. Specify the key-value pair for `redpanda.iceberg.mode` in the request body.
145+
* The Data Plane API to link:/api/doc/cloud-dataplane/operation/operation-topicservice_createtopic[create a new topic] or link:/api/doc/cloud-dataplane/operation/operation-topicservice_updatetopicconfigurations[update a property for an existing topic]. Specify the key-value pair for `redpanda.iceberg.mode` in the request body.
146146
endif::[]
147147
+
148148
The following examples show how to use `rpk` to create a new topic or alter the configuration for an existing topic, setting the Iceberg mode to `key_value`.

modules/manage/pages/kubernetes/networking/k-connect-to-redpanda.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ kubectl exec <pod-name> --namespace <namespace> -- curl https://<pod-name>.redpa
235235
--key /etc/tls/certs/redpanda-client/tls.key
236236
----
237237

238-
For all available endpoints, see xref:api:ROOT:pandaproxy-rest.adoc[].
238+
For all available endpoints, see the link:/api/doc/http-proxy/[HTTP Proxy API reference].
239239

240240
=== Connect to internal Schema Registry
241241

@@ -366,7 +366,7 @@ kubectl exec <pod-name> --namespace <namespace> -- \
366366
367367
NOTE: If the broker's certificate is signed by a well-known, trusted CA, and your system's CA trust store is reliable, you may omit `--cacert`.
368368
369-
For all available endpoints, see xref:api:ROOT:admin-api.adoc[].
369+
For all available endpoints, see the link:/api/doc/admin/[Admin API reference].
370370
371371
--
372372
====
@@ -577,7 +577,7 @@ curl https://<pod-name>.redpanda.<namespace>.svc.cluster.local:30082/topics \
577577
--key /etc/tls/certs/external/tls.key
578578
----
579579

580-
For all available endpoints, see xref:api:ROOT:pandaproxy-rest.adoc[].
580+
For all available endpoints, see the link:/api/doc/http-proxy/[HTTP Proxy API reference].
581581

582582
=== Connect to external Schema Registry
583583

@@ -684,7 +684,7 @@ curl https://<pod-name>.redpanda.<namespace>.svc.cluster.local:31644/v1/node_con
684684
--key /etc/tls/certs/external/tls.key
685685
----
686686

687-
For all available endpoints, see xref:api:ROOT:admin-api.adoc[].
687+
For all available endpoints, see the link:/api/doc/admin/[Admin API reference].
688688

689689
== Next steps
690690

modules/manage/pages/schema-reg/schema-reg-authorization.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ The `Invalid license: not present` error indicates that the user is trying to cr
370370
ifndef::env-cloud[]
371371
* xref:manage:schema-reg/schema-reg-overview.adoc[]
372372
* xref:reference:rpk/rpk-registry/rpk-registry.adoc[rpk registry]
373-
* xref:api:ROOT:pandaproxy-schema-registry.adoc[Schema Registry API]
373+
* link:/api/doc/schema-registry/[Schema Registry API]
374374
* xref:reference:node-configuration-sample.adoc[] (search for `schema_registry`)
375375
* xref:manage:monitoring.adoc#service-level-queries[Monitor Schema Registry service-level metrics]
376376
* xref:deploy:redpanda/manual/node-property-configuration.adoc[Configure broker properties for Schema Registry]
@@ -379,7 +379,7 @@ endif::[]
379379
ifdef::env-cloud[]
380380
* xref:manage:schema-reg/schema-reg-overview.adoc[]
381381
* xref:reference:rpk/rpk-registry/rpk-registry.adoc[rpk registry]
382-
* xref:api:ROOT:pandaproxy-schema-registry.adoc[Schema Registry API]
382+
* link:/api/doc/schema-registry/[Schema Registry API]
383383
* xref:manage:monitoring.adoc#service-level-queries[Monitor Schema Registry service-level metrics]
384384
* xref:manage:schema-reg/record-deserialization.adoc#schema-registry[Deserialization]
385385

modules/manage/pages/schema-reg/schema-reg-overview.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ All CRUD operations are supported for the JSON Schema (`json-schema`), and Redpa
144144

145145
=== Limitations
146146

147-
Schemas are held in subjects. Subjects have a compatibility configuration associated with them, either directly specified by a user, or inherited by the default. See `PUT /config` and `PUT/config/\{subject}` in the xref:api:ROOT:pandaproxy-schema-registry.adoc[Schema Registry API].
147+
Schemas are held in subjects. Subjects have a compatibility configuration associated with them, either directly specified by a user, or inherited by the default. See `PUT /config` and `PUT/config/\{subject}` in the link:/api/doc/schema-registry/[Schema Registry API].
148148

149149
If you have inserted a second schema into a subject where the compatibility level is anything but `NONE`, then any JSON Schema containing the following items are rejected:
150150

@@ -165,15 +165,15 @@ endif::[]
165165

166166
== Suggested reading
167167
ifndef::env-cloud[]
168-
* xref:api:ROOT:pandaproxy-schema-registry.adoc[Schema Registry API]
168+
* link:/api/doc/schema-registry/[Schema Registry API]
169169
* xref:console:config/deserialization.adoc[Deserialization]
170170
* xref:reference:node-configuration-sample.adoc[] (search for `schema_registry`)
171171
* xref:manage:monitoring.adoc#service-level-queries[Monitor Schema Registry service-level metrics]
172172
* xref:deploy:redpanda/manual/node-property-configuration.adoc[Configure broker properties for Schema Registry]
173173

174174
endif::[]
175175
ifdef::env-cloud[]
176-
* xref:api:ROOT:pandaproxy-schema-registry.adoc[Schema Registry API]
176+
* link:/api/doc/schema-registry/[Schema Registry API]
177177
* xref:manage:schema-reg/record-deserialization.adoc[Deserialization]
178178
* xref:manage:monitoring.adoc#service-level-queries[Monitor Schema Registry service-level metrics]
179179

modules/manage/partials/authentication.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1354,7 +1354,7 @@ Each of the HTTP APIs implements its own permission model with different levels
13541354

13551355
The Admin API primarily requires superuser privileges, with a few exceptions for read-only status endpoints.
13561356

1357-
For a complete list of all Admin API endpoints, see see xref:api:ROOT:admin-api.adoc[].
1357+
For a complete list of all Admin API endpoints, see the link:/api/doc/admin/[Admin API reference].
13581358

13591359
==== Schema Registry API permissions
13601360

@@ -1539,7 +1539,7 @@ curl https://localhost:8082/topics --cacert <path-to-ca>/ca.crt -u <username>:<p
15391539
NOTE: If the broker's certificate is signed by a well-known, trusted CA, and you're confident about the integrity of your system's CA trust store, you don't need the `--cacert` flag.
15401540
endif::[]
15411541

1542-
For all available endpoints, see xref:api:ROOT:pandaproxy-rest.adoc[].
1542+
For all available endpoints, see the link:/api/doc/http-proxy/[HTTP Proxy API reference].
15431543

15441544
===== Connect to the Schema Registry API
15451545

@@ -1738,7 +1738,7 @@ curl https://localhost:8082/topics --cacert <path-to-ca>/ca.crt -H "Authorizatio
17381738
NOTE: If the broker's certificate is signed by a well-known, trusted CA, and you're confident about the integrity of your system's CA trust store, you don't need the `--cacert` flag.
17391739
endif::[]
17401740

1741-
For all available endpoints, see xref:api:ROOT:pandaproxy-rest.adoc[].
1741+
For all available endpoints, see the link:/api/doc/http-proxy/[HTTP Proxy API reference].
17421742

17431743
===== Connect to the Schema Registry API
17441744

modules/manage/partials/iceberg/about-iceberg-topics.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To enable Iceberg for Redpanda topics, you must have the following:
3434
ifdef::env-cloud[]
3535
* A running xref:get-started:cluster-types/byoc/index.adoc[BYOC] cluster on Redpanda version 25.1 or later. The Iceberg integration is supported only for BYOC, and the cluster properties to configure Iceberg are available with v25.1.
3636
* rpk: See xref:get-started:rpk-install.adoc[].
37-
* Familiarity with the Redpanda Cloud API. You must xref:redpanda-cloud:manage:api/cloud-api-authentication.adoc[authenticate] to the Cloud API and use the Control Plane API to update your cluster configuration.
37+
* Familiarity with the Redpanda Cloud API. You must link:/api/doc/cloud-controlplane/authentication[authenticate] to the Cloud API and use the Control Plane API to update your cluster configuration.
3838
endif::[]
3939

4040
ifndef::env-cloud[]
@@ -195,7 +195,7 @@ The Redpanda cluster ID is also used as the container name (ID) and the storage
195195

196196
For Azure clusters, you must add the public IP addresses or ranges from the REST catalog service, or other clients requiring access to the Iceberg data, to your cluster's allow list. Alternatively, add subnet IDs to the allow list if the requests originate from the same Azure region.
197197

198-
For example, to add subnet IDs to the allow list through the Control Plane API xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /v1/clusters/<cluster-id>`] endpoint, run:
198+
For example, to add subnet IDs to the allow list through the Control Plane API link:/api/doc/cloud-controlplane/operation/operation-clusterservice_updatecluster[`PATCH /v1/clusters/<cluster-id>`] endpoint, run:
199199

200200
[,bash]
201201
----

modules/manage/partials/iceberg/use-iceberg-catalogs.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ Cloud API::
149149
+
150150
--
151151
. Authenticate and make a `GET /v1/clusters/\{id}` request to xref:manage:api/cloud-dataplane-api.adoc#get-data-plane-api-url[retrieve the Data Plane API URL] for your cluster.
152-
. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1/secrets[`POST /v1/secrets`]. You must use a Base64-encoded secret.
152+
. Make a request to link:/api/doc/cloud-dataplane/operation/operation-secretservice_createsecret[`POST /v1/secrets`]. You must use a Base64-encoded secret.
153153
+
154154
[,bash]
155155
----
@@ -196,7 +196,7 @@ rpk cluster config set iceberg_rest_catalog_client_secret ${secrets.<secret-name
196196
Cloud API::
197197
+
198198
--
199-
Make a request to the xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /v1/clusters/<cluster-id>`] endpoint of the Control Plane API.
199+
Make a request to the link:/api/doc/cloud-controlplane/operation/operation-clusterservice_updatecluster[`PATCH /v1/clusters/<cluster-id>`] endpoint of the Control Plane API.
200200
201201
[,bash]
202202
----

0 commit comments

Comments
 (0)