Doc: Fix descriptions for resource IDs

MaximilianKoestler · Dec 18, 2023 · 6c1dad9 · 6c1dad9
1 parent d4b9ef2
commit 6c1dad9
Show file tree

Hide file tree

Showing 2 changed files with 67 additions and 10 deletions.
diff --git a/openapi/hcloud.json b/openapi/hcloud.json
@@ -6,7 +6,7 @@
     "contact": {
       "url": "https://docs.hetzner.cloud/"
     },
-    "version": "4053943-dirty"
+    "version": "d4b9ef2-dirty"
   },
   "servers": [
     {
@@ -7658,16 +7658,16 @@
         "description": "Returns all Action objects for a Certificate. You can sort the results by using the `sort` URI parameter, and filter them with the `status` parameter.\n\nOnly type `managed` Certificates can have Actions. For type `uploaded` Certificates the `actions` key will always contain an empty array.\n",
         "parameters": [
           {
-            "description": "ID of the Action.",
+            "description": "ID of the Certificate",
             "in": "path",
             "name": "id",
             "required": true,
             "schema": {
-              "description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
+              "description": "ID of the Certificate. Limited to 52 bits to ensure compatability with JSON double precision floats.",
               "example": 42,
               "format": "int64",
               "maximum": 9007199254740991,
-              "title": "Action ID",
+              "title": "Certificate ID",
               "type": "integer"
             }
           },
@@ -8398,16 +8398,16 @@
         "description": "Returns all Action objects for a Firewall. You can sort the results by using the `sort` URI parameter, and filter them with the `status` parameter.",
         "parameters": [
           {
-            "description": "ID of the Action.",
+            "description": "ID of the Firewall",
             "in": "path",
             "name": "id",
             "required": true,
             "schema": {
-              "description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
+              "description": "ID of the Firewall. Limited to 52 bits to ensure compatability with JSON double precision floats.",
               "example": 42,
               "format": "int64",
               "maximum": 9007199254740991,
-              "title": "Action ID",
+              "title": "Firewall ID",
               "type": "integer"
             }
           },
@@ -15041,16 +15041,16 @@
         "description": "Returns all Action objects for a Server. You can `sort` the results by using the sort URI parameter, and filter them with the `status` parameter.",
         "parameters": [
           {
-            "description": "ID of the Action.",
+            "description": "ID of the Server",
             "in": "path",
             "name": "id",
             "required": true,
             "schema": {
-              "description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
+              "description": "ID of the Server. Limited to 52 bits to ensure compatability with JSON double precision floats.",
               "example": 42,
               "format": "int64",
               "maximum": 9007199254740991,
-              "title": "Action ID",
+              "title": "Server ID",
               "type": "integer"
             }
           },

diff --git a/resources/document_transformations.json b/resources/document_transformations.json
@@ -249,5 +249,62 @@
     "set": {
       "description": "ID of the Action"
     }
+  },
+
+  {
+    "path": ["paths", "/firewalls/{id}/actions", "get", "parameters", 0],
+    "set": {
+      "description": "ID of the Firewall"
+    }
+  },
+  {
+    "path": ["paths", "/firewalls/{id}/actions", "get", "parameters", 0, "schema"],
+    "set": {
+      "description": "ID of the Firewall. Limited to 52 bits to ensure compatability with JSON double precision floats."
+    }
+  },
+  {
+    "path": ["paths", "/firewalls/{id}/actions", "get", "parameters", 0, "schema"],
+    "set": {
+      "title": "Firewall ID"
+    }
+  },
+
+  {
+    "path": ["paths", "/certificates/{id}/actions", "get", "parameters", 0],
+    "set": {
+      "description": "ID of the Certificate"
+    }
+  },
+  {
+    "path": ["paths", "/certificates/{id}/actions", "get", "parameters", 0, "schema"],
+    "set": {
+      "description": "ID of the Certificate. Limited to 52 bits to ensure compatability with JSON double precision floats."
+    }
+  },
+  {
+    "path": ["paths", "/certificates/{id}/actions", "get", "parameters", 0, "schema"],
+    "set": {
+      "title": "Certificate ID"
+    }
+  },
+
+  {
+    "path": ["paths", "/servers/{id}/actions", "get", "parameters", 0],
+    "set": {
+      "description": "ID of the Server"
+    }
+  },
+  {
+    "path": ["paths", "/servers/{id}/actions", "get", "parameters", 0, "schema"],
+    "set": {
+      "description": "ID of the Server. Limited to 52 bits to ensure compatability with JSON double precision floats."
+    }
+  },
+  {
+    "path": ["paths", "/servers/{id}/actions", "get", "parameters", 0, "schema"],
+    "set": {
+      "title": "Server ID"
+    }
   }
 ]