Skip to content

Commit a2b194f

Browse files
Fix tag external_docs links (and cleanup unused) (#3404)
I'm updating the docs site so these automatically redirect to the associated section. Changing the system ones so they can be easily handled. Removing the tags that are not used.
1 parent ce2d2db commit a2b194f

File tree

2 files changed

+12
-51
lines changed

2 files changed

+12
-51
lines changed

nexus/src/external_api/tag-config.json

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"hidden": {
1212
"description": "TODO operations that will not ship to customers",
1313
"external_docs": {
14-
"url": "http://docs.oxide.computer/api/"
14+
"url": "http://docs.oxide.computer/api"
1515
}
1616
},
1717
"images": {
@@ -26,12 +26,6 @@
2626
"url": "http://docs.oxide.computer/api/instances"
2727
}
2828
},
29-
"ip-pools": {
30-
"description": "IP Pools contain external IP addresses that can be assigned to virtual machine instances.",
31-
"external_docs": {
32-
"url": "http://docs.oxide.computer/api/ip-pools"
33-
}
34-
},
3529
"login": {
3630
"description": "Authentication endpoints",
3731
"external_docs": {
@@ -62,12 +56,6 @@
6256
"url": "http://docs.oxide.computer/api/roles"
6357
}
6458
},
65-
"sagas": {
66-
"description": "Sagas are the abstraction used to represent multi-step operations within the Oxide deployment. These operations can be used to query saga status and report errors.",
67-
"external_docs": {
68-
"url": "http://docs.oxide.computer/api/sagas"
69-
}
70-
},
7159
"session": {
7260
"description": "Information pertaining to the current session.",
7361
"external_docs": {
@@ -86,40 +74,34 @@
8674
"url": "http://docs.oxide.computer/api/snapshots"
8775
}
8876
},
89-
"system": {
90-
"description": "Internal system information",
91-
"external_docs": {
92-
"url": "http://docs.oxide.computer/api/system"
93-
}
94-
},
9577
"system/hardware": {
9678
"description": "These operations pertain to hardware inventory and management. Racks are the unit of expansion of an Oxide deployment. Racks are in turn composed of sleds, switches, power supplies, and a cabled backplane.",
9779
"external_docs": {
98-
"url": "http://docs.oxide.computer/api/system/hardware"
80+
"url": "http://docs.oxide.computer/api/system-hardware"
9981
}
10082
},
10183
"system/metrics": {
10284
"description": "Metrics provide insight into the operation of the Oxide deployment. These include telemetry on hardware and software components that can be used to understand the current state as well as to diagnose issues.",
10385
"external_docs": {
104-
"url": "http://docs.oxide.computer/api/system/metrics"
86+
"url": "http://docs.oxide.computer/api/system-metrics"
10587
}
10688
},
10789
"system/networking": {
10890
"description": "This provides rack-level network configuration.",
10991
"external_docs": {
110-
"url": "http://docs.oxide.computer/api/system/networking"
92+
"url": "http://docs.oxide.computer/api/system-networking"
11193
}
11294
},
11395
"system/silos": {
11496
"description": "Silos represent a logical partition of users and resources.",
11597
"external_docs": {
116-
"url": "http://docs.oxide.computer/api/system/silos"
98+
"url": "http://docs.oxide.computer/api/system-silos"
11799
}
118100
},
119101
"system/update": {
120102
"description": "This includes operations related to system updates.",
121103
"external_docs": {
122-
"url": "http://docs.oxide.computer/api/system/update"
104+
"url": "http://docs.oxide.computer/api/system-update"
123105
}
124106
}
125107
}

openapi/nexus.json

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -14431,7 +14431,7 @@
1443114431
"name": "hidden",
1443214432
"description": "TODO operations that will not ship to customers",
1443314433
"externalDocs": {
14434-
"url": "http://docs.oxide.computer/api/"
14434+
"url": "http://docs.oxide.computer/api"
1443514435
}
1443614436
},
1443714437
{
@@ -14448,13 +14448,6 @@
1444814448
"url": "http://docs.oxide.computer/api/instances"
1444914449
}
1445014450
},
14451-
{
14452-
"name": "ip-pools",
14453-
"description": "IP Pools contain external IP addresses that can be assigned to virtual machine instances.",
14454-
"externalDocs": {
14455-
"url": "http://docs.oxide.computer/api/ip-pools"
14456-
}
14457-
},
1445814451
{
1445914452
"name": "login",
1446014453
"description": "Authentication endpoints",
@@ -14483,13 +14476,6 @@
1448314476
"url": "http://docs.oxide.computer/api/roles"
1448414477
}
1448514478
},
14486-
{
14487-
"name": "sagas",
14488-
"description": "Sagas are the abstraction used to represent multi-step operations within the Oxide deployment. These operations can be used to query saga status and report errors.",
14489-
"externalDocs": {
14490-
"url": "http://docs.oxide.computer/api/sagas"
14491-
}
14492-
},
1449314479
{
1449414480
"name": "session",
1449514481
"description": "Information pertaining to the current session.",
@@ -14511,46 +14497,39 @@
1451114497
"url": "http://docs.oxide.computer/api/snapshots"
1451214498
}
1451314499
},
14514-
{
14515-
"name": "system",
14516-
"description": "Internal system information",
14517-
"externalDocs": {
14518-
"url": "http://docs.oxide.computer/api/system"
14519-
}
14520-
},
1452114500
{
1452214501
"name": "system/hardware",
1452314502
"description": "These operations pertain to hardware inventory and management. Racks are the unit of expansion of an Oxide deployment. Racks are in turn composed of sleds, switches, power supplies, and a cabled backplane.",
1452414503
"externalDocs": {
14525-
"url": "http://docs.oxide.computer/api/system/hardware"
14504+
"url": "http://docs.oxide.computer/api/system-hardware"
1452614505
}
1452714506
},
1452814507
{
1452914508
"name": "system/metrics",
1453014509
"description": "Metrics provide insight into the operation of the Oxide deployment. These include telemetry on hardware and software components that can be used to understand the current state as well as to diagnose issues.",
1453114510
"externalDocs": {
14532-
"url": "http://docs.oxide.computer/api/system/metrics"
14511+
"url": "http://docs.oxide.computer/api/system-metrics"
1453314512
}
1453414513
},
1453514514
{
1453614515
"name": "system/networking",
1453714516
"description": "This provides rack-level network configuration.",
1453814517
"externalDocs": {
14539-
"url": "http://docs.oxide.computer/api/system/networking"
14518+
"url": "http://docs.oxide.computer/api/system-networking"
1454014519
}
1454114520
},
1454214521
{
1454314522
"name": "system/silos",
1454414523
"description": "Silos represent a logical partition of users and resources.",
1454514524
"externalDocs": {
14546-
"url": "http://docs.oxide.computer/api/system/silos"
14525+
"url": "http://docs.oxide.computer/api/system-silos"
1454714526
}
1454814527
},
1454914528
{
1455014529
"name": "system/update",
1455114530
"description": "This includes operations related to system updates.",
1455214531
"externalDocs": {
14553-
"url": "http://docs.oxide.computer/api/system/update"
14532+
"url": "http://docs.oxide.computer/api/system-update"
1455414533
}
1455514534
},
1455614535
{

0 commit comments

Comments
 (0)