Skip to content

Commit 3295ab1

Browse files
backport of commit 30e63fe (#25917)
Co-authored-by: Aimee Ukasick <[email protected]>
1 parent bd28046 commit 3295ab1

File tree

10 files changed

+20
-28
lines changed

10 files changed

+20
-28
lines changed

website/content/api-docs/acl/roles.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ has been replicated to the region, and may lag behind the authoritative region.
219219

220220
| Method | Path | Produces |
221221
| ------ | -------------------- | ------------------ |
222-
| `GET` | `/acl/role/:role_id` | `application/json` |
222+
| `GET` | `/v1/acl/role/:role_id` | `application/json` |
223223

224224
The table below shows this endpoint's support for
225225
[blocking queries](/nomad/api-docs#blocking-queries),

website/content/api-docs/allocations.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -864,7 +864,7 @@ allocation ID.
864864

865865
| Method | Path | Produces |
866866
| ------ | -------------------------------- | ------------------ |
867-
| `GET` | `/allocation/:alloc_id/services` | `application/json` |
867+
| `GET` | `/v1/allocation/:alloc_id/services` | `application/json` |
868868

869869
The table below shows this endpoint's support for
870870
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
@@ -919,7 +919,7 @@ to the passed allocation ID.
919919

920920
| Method | Path | Produces |
921921
| ------ | ------------------------------ | ------------------ |
922-
| `GET` | `/allocation/:alloc_id/checks` | `application/json` |
922+
| `GET` | `/v1/allocation/:alloc_id/checks` | `application/json` |
923923

924924
The table below shows this endpoint's support for
925925
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and

website/content/api-docs/jobs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2531,7 +2531,7 @@ The endpoint is used to read all services registered within Nomad belonging to t
25312531

25322532
| Method | Path | Produces |
25332533
| ------ | ----------------------- | ------------------ |
2534-
| `GET` | `/job/:job_id/services` | `application/json` |
2534+
| `GET` | `/v1/job/:job_id/services` | `application/json` |
25352535

25362536
The table below shows this endpoint's support for
25372537
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and

website/content/api-docs/quotas.mdx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,7 @@ description: The /quota endpoints are used to query for and interact with quotas
88

99
The `/quota` endpoints are used to query for and interact with quotas.
1010

11-
<EnterpriseAlert>
12-
This API endpoint and functionality only exists in Nomad Enterprise. This is
13-
not present in the open source version of Nomad.
14-
</EnterpriseAlert>
11+
<EnterpriseAlert product="nomad"/>
1512

1613
## List Quota Specifications
1714

website/content/api-docs/recommendations.mdx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,7 @@ description: >-
1111
The `/recommendation` endpoints are used to query and interact with Dynamic
1212
Application Sizing recommendations.
1313

14-
<EnterpriseAlert>
15-
This API endpoint and functionality only exists in Nomad Enterprise. This is
16-
not present in the open source version of Nomad.
17-
</EnterpriseAlert>
14+
<EnterpriseAlert product="nomad"/>
1815

1916
## List Recommendations
2017

website/content/api-docs/scaling-policies.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This endpoint returns the scaling policies from all jobs.
1414

1515
| Method | Path | Produces |
1616
| ------ | ------------------- | ------------------ |
17-
| `GET` | `/scaling/policies` | `application/json` |
17+
| `GET` | `/v1/scaling/policies` | `application/json` |
1818

1919
The table below shows this endpoint's support for
2020
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
@@ -102,7 +102,7 @@ This endpoint reads a specific scaling policy.
102102

103103
| Method | Path | Produces |
104104
| ------ | ---------------------------- | ------------------ |
105-
| `GET` | `/scaling/policy/:policy_id` | `application/json` |
105+
| `GET` | `/v1/scaling/policy/:policy_id` | `application/json` |
106106

107107
The table below shows this endpoint's support for
108108
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and

website/content/api-docs/sentinel-policies.mdx

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,7 @@ For more details about Sentinel policies, please see the [Sentinel Policy Guide]
1313

1414
Sentinel endpoints are only available when ACLs are enabled. For more details about ACLs, please see the [ACL Guide](/nomad/tutorials/access-control).
1515

16-
<EnterpriseAlert>
17-
This API endpoint and functionality only exists in Nomad Enterprise. This is
18-
not present in the open source version of Nomad.
19-
</EnterpriseAlert>
16+
<EnterpriseAlert product="nomad"/>
2017

2118
## List Policies
2219

@@ -25,7 +22,7 @@ to the region, and may lag behind the authoritative region.
2522

2623
| Method | Path | Produces |
2724
| ------ | -------------------- | ------------------ |
28-
| `GET` | `/sentinel/policies` | `application/json` |
25+
| `GET` | `/v1/sentinel/policies` | `application/json` |
2926

3027
The table below shows this endpoint's support for
3128
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
@@ -65,7 +62,7 @@ authoritative region.
6562

6663
| Method | Path | Produces |
6764
| ------ | ------------------------------- | -------------- |
68-
| `POST` | `/sentinel/policy/:policy_name` | `(empty body)` |
65+
| `POST` | `/v1/sentinel/policy/:policy_name` | `(empty body)` |
6966

7067
The table below shows this endpoint's support for
7168
[blocking queries](/nomad/api-docs#blocking-queries) and
@@ -117,7 +114,7 @@ replicated to the region, and may lag behind the authoritative region.
117114

118115
| Method | Path | Produces |
119116
| ------ | ------------------------------- | ------------------ |
120-
| `GET` | `/sentinel/policy/:policy_name` | `application/json` |
117+
| `GET` | `/v1/sentinel/policy/:policy_name` | `application/json` |
121118

122119
The table below shows this endpoint's support for
123120
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
@@ -156,7 +153,7 @@ authoritative region.
156153

157154
| Method | Path | Produces |
158155
| -------- | ------------------------------- | -------------- |
159-
| `DELETE` | `/sentinel/policy/:policy_name` | `(empty body)` |
156+
| `DELETE` | `/v1/sentinel/policy/:policy_name` | `(empty body)` |
160157

161158
The table below shows this endpoint's support for
162159
[blocking queries](/nomad/api-docs#blocking-queries) and

website/content/api-docs/services.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ This endpoint reads a specific service.
6262

6363
| Method | Path | Produces |
6464
| ------ | ------------------------ | ------------------ |
65-
| `GET` | `/service/:service_name` | `application/json` |
65+
| `GET` | `/v1/service/:service_name` | `application/json` |
6666

6767
The table below shows this endpoint's support for
6868
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
@@ -179,4 +179,4 @@ $ curl \
179179
https://localhost:4646/v1/service/example-cache-redis/_nomad-task-ba731da0-6df9-9858-ef23-806e9758a899-redis-example-cache-redis-db
180180
```
181181

182-
[hash]: https://en.wikipedia.org/wiki/Rendezvous_hashing
182+
[hash]: https://en.wikipedia.org/wiki/Rendezvous_hashing

website/content/api-docs/status.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This endpoint returns the address of the current leader in the region.
1414

1515
| Method | Path | Produces |
1616
| ------ | ---------------- | ------------------ |
17-
| `GET` | `/status/leader` | `application/json` |
17+
| `GET` | `/v1/status/leader` | `application/json` |
1818

1919
The table below shows this endpoint's support for
2020
[blocking queries](/nomad/api-docs#blocking-queries) and
@@ -43,7 +43,7 @@ This endpoint returns the set of raft peers in the region.
4343

4444
| Method | Path | Produces |
4545
| ------ | --------------- | ------------------ |
46-
| `GET` | `/status/peers` | `application/json` |
46+
| `GET` | `/v1/status/peers` | `application/json` |
4747

4848
The table below shows this endpoint's support for
4949
[blocking queries](/nomad/api-docs#blocking-queries) and

website/content/api-docs/ui.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ description: The /ui namespace is used to access the Nomad web user interface.
66

77
# Nomad Web UI
88

9-
The Nomad UI is accessible at `/ui`. It is not namespaced by version. A request to `/` will also redirect to `/ui`.
9+
The Nomad UI is accessible at `/ui`. It is not namespaced by version, so do not
10+
prepend `/vi` to this endpoint. A request to `/` redirects to `/ui`.
1011

1112
## List Jobs
1213

@@ -559,7 +560,7 @@ authenticate all future requests to allow read access to additional resources.
559560

560561
The Nomad UI supports several keyboard shortcuts in order to help users navigate and operate Nomad. You can use common key commands to dig into jobs, view logs, monitor evaluations, and more.
561562

562-
Type `?` from anywhere in the UI to launch the Keyboard Shortcuts panel.
563+
Type `?` from anywhere in the UI to launch the Keyboard Shortcuts panel.
563564

564565
### Default key commands:
565566

0 commit comments

Comments
 (0)