Skip to content

Commit

Permalink
Schema!: Add maximum to action IDs and improve doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@MaximilianKoestler
MaximilianKoestler committed Nov 15, 2023
1 parent e02c304 commit a043108
Showing 1 changed file with 94 additions and 14 deletions.
108 changes: 94 additions & 14 deletions openapi/hcloud.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"contact": {
"url": "https://docs.hetzner.cloud/"
},
"version": "e411db5"
"version": "e02c304"
},
"servers": [
{
Expand Down Expand Up @@ -109,6 +109,8 @@
"description": "ID of the Action",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
},
"progress": {
Expand Down Expand Up @@ -173,6 +175,8 @@
"description": "ID of the Action",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
},
"progress": {
Expand Down Expand Up @@ -6958,12 +6962,16 @@
"description": "Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` parameter.",
"parameters": [
{
"description": "Can be used multiple times, the response will contain only Actions with specified IDs",
"description": "Can be used multiple times, the response will contain only Actions with specified IDs.",
"in": "query",
"name": "id",
"required": false,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
},
Expand Down Expand Up @@ -7506,12 +7514,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 Resource",
"description": "ID of the Action.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
},
Expand Down Expand Up @@ -7743,12 +7755,16 @@
"description": "Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` and `id` parameter.",
"parameters": [
{
"description": "Can be used multiple times, the response will contain only Actions with specified IDs",
"description": "Can be used multiple times, the response will contain only Actions with specified IDs.",
"in": "query",
"name": "id",
"required": false,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
},
Expand Down Expand Up @@ -7845,7 +7861,11 @@
"name": "id",
"required": true,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
}
Expand Down Expand Up @@ -8222,12 +8242,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 Resource",
"description": "ID of the Action.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
},
Expand Down Expand Up @@ -8669,12 +8693,16 @@
"description": "Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` and `id` parameter.",
"parameters": [
{
"description": "Can be used multiple times, the response will contain only Actions with specified IDs",
"description": "Can be used multiple times, the response will contain only Actions with specified IDs.",
"in": "query",
"name": "id",
"required": false,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
},
Expand Down Expand Up @@ -9539,12 +9567,16 @@
"description": "Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` and `id` parameter.",
"parameters": [
{
"description": "Can be used multiple times, the response will contain only Actions with specified IDs",
"description": "Can be used multiple times, the response will contain only Actions with specified IDs.",
"in": "query",
"name": "id",
"required": false,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
},
Expand Down Expand Up @@ -9641,7 +9673,11 @@
"name": "id",
"required": true,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
}
Expand Down Expand Up @@ -10183,12 +10219,16 @@
"description": "Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` and `id` parameter.",
"parameters": [
{
"description": "Can be used multiple times, the response will contain only Actions with specified IDs",
"description": "Can be used multiple times, the response will contain only Actions with specified IDs.",
"in": "query",
"name": "id",
"required": false,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
},
Expand Down Expand Up @@ -12078,12 +12118,16 @@
"description": "Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` and `id` parameter.",
"parameters": [
{
"description": "Can be used multiple times, the response will contain only Actions with specified IDs",
"description": "Can be used multiple times, the response will contain only Actions with specified IDs.",
"in": "query",
"name": "id",
"required": false,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
},
Expand Down Expand Up @@ -12180,7 +12224,11 @@
"name": "id",
"required": true,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
}
Expand Down Expand Up @@ -13102,12 +13150,16 @@
"description": "Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` and `id` parameter.",
"parameters": [
{
"description": "Can be used multiple times, the response will contain only Actions with specified IDs",
"description": "Can be used multiple times, the response will contain only Actions with specified IDs.",
"in": "query",
"name": "id",
"required": false,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
},
Expand Down Expand Up @@ -14100,12 +14152,16 @@
"description": "Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` and `id` parameter.",
"parameters": [
{
"description": "Can be used multiple times, the response will contain only Actions with specified IDs",
"description": "Can be used multiple times, the response will contain only Actions with specified IDs.",
"in": "query",
"name": "id",
"required": false,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
},
Expand Down Expand Up @@ -14202,7 +14258,11 @@
"name": "id",
"required": true,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
}
Expand Down Expand Up @@ -14759,12 +14819,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 Resource",
"description": "ID of the Action.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
},
Expand Down Expand Up @@ -16404,12 +16468,16 @@
"description": "Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` and `id` parameter.",
"parameters": [
{
"description": "Can be used multiple times, the response will contain only Actions with specified IDs",
"description": "Can be used multiple times, the response will contain only Actions with specified IDs.",
"in": "query",
"name": "id",
"required": false,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
},
Expand Down Expand Up @@ -16506,7 +16574,11 @@
"name": "id",
"required": true,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
}
Expand Down Expand Up @@ -17540,12 +17612,16 @@
"description": "Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` and `id` parameter.",
"parameters": [
{
"description": "Can be used multiple times, the response will contain only Actions with specified IDs",
"description": "Can be used multiple times, the response will contain only Actions with specified IDs.",
"in": "query",
"name": "id",
"required": false,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
},
Expand Down Expand Up @@ -17642,7 +17718,11 @@
"name": "id",
"required": true,
"schema": {
"description": "ID of the Action. Limited to 52 bits to ensure compatability with JSON double precision floats.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"title": "Action ID",
"type": "integer"
}
}
Expand Down

0 comments on commit a043108

Please sign in to comment.