Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 78919d9

Browse files
mtojekmtojek
committed
Fix: swaggertype
1 parent 78dc628 commit 78919d9

File tree

6 files changed

+13
-59
lines changed

6 files changed

+13
-59
lines changed

‎coderd/apidoc/docs.go

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1722,18 +1722,6 @@ const docTemplate = `{
17221722
}
17231723
}
17241724
},
1725-
"codersdk.NullTime": {
1726-
"type": "object",
1727-
"properties": {
1728-
"time": {
1729-
"type": "string"
1730-
},
1731-
"valid": {
1732-
"description": "Valid is true if Time is not NULL",
1733-
"type": "boolean"
1734-
}
1735-
}
1736-
},
17371725
"codersdk.OAuth2Config": {
17381726
"type": "object",
17391727
"properties": {
@@ -2366,7 +2354,8 @@ const docTemplate = `{
23662354
"type": "integer"
23672355
},
23682356
"deadline": {
2369-
"$ref": "#/definitions/codersdk.NullTime"
2357+
"type": "string",
2358+
"format": "date-time"
23702359
},
23712360
"id": {
23722361
"type": "string",

‎coderd/apidoc/swagger.json

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1574,18 +1574,6 @@
15741574
}
15751575
}
15761576
},
1577-
"codersdk.NullTime": {
1578-
"type": "object",
1579-
"properties": {
1580-
"time": {
1581-
"type": "string"
1582-
},
1583-
"valid": {
1584-
"description": "Valid is true if Time is not NULL",
1585-
"type": "boolean"
1586-
}
1587-
}
1588-
},
15891577
"codersdk.OAuth2Config": {
15901578
"type": "object",
15911579
"properties": {
@@ -2208,7 +2196,8 @@
22082196
"type": "integer"
22092197
},
22102198
"deadline": {
2211-
"$ref": "#/definitions/codersdk.NullTime"
2199+
"type": "string",
2200+
"format": "date-time"
22122201
},
22132202
"id": {
22142203
"type": "string",

‎codersdk/workspacebuilds.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ type WorkspaceBuild struct {
6767
Job ProvisionerJob `json:"job"`
6868
Reason BuildReason `db:"reason" json:"reason"`
6969
Resources []WorkspaceResource `json:"resources"`
70-
Deadline NullTime `json:"deadline,omitempty"`
70+
Deadline NullTime `json:"deadline,omitempty" swaggertype:"string" format:"date-time"`
7171
Status WorkspaceStatus `json:"status" enums:"pending,starting,running,stopping,stopped,failed,canceling,canceled,deleting,deleted"`
7272
DailyCost int32 `json:"daily_cost"`
7373
}

‎docs/api/schemas.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2788,10 +2788,7 @@ CreateParameterRequest is a structure used to create a new parameter value for a
27882788
"build_number": 0,
27892789
"created_at": "2019-08-24T14:15:22Z",
27902790
"daily_cost": 0,
2791-
"deadline": {
2792-
"time": "string",
2793-
"valid": true
2794-
},
2791+
"deadline": "2019-08-24T14:15:22Z",
27952792
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
27962793
"initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
27972794
"initiator_name": "string",
@@ -3059,10 +3056,7 @@ CreateParameterRequest is a structure used to create a new parameter value for a
30593056
"build_number": 0,
30603057
"created_at": "2019-08-24T14:15:22Z",
30613058
"daily_cost": 0,
3062-
"deadline": {
3063-
"time": "string",
3064-
"valid": true
3065-
},
3059+
"deadline": "2019-08-24T14:15:22Z",
30663060
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
30673061
"initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
30683062
"initiator_name": "string",
@@ -3175,7 +3169,7 @@ CreateParameterRequest is a structure used to create a new parameter value for a
31753169
| `build_number` | integer | false | | |
31763170
| `created_at` | string | false | | |
31773171
| `daily_cost` | integer | false | | |
3178-
| `deadline` | string(time) or `null` | false | | |
3172+
| `deadline` | string | false | | |
31793173
| `id` | string | false | | |
31803174
| `initiator_id` | string | false | | |
31813175
| `initiator_name` | string | false | | |
@@ -3344,10 +3338,7 @@ CreateParameterRequest is a structure used to create a new parameter value for a
33443338
"build_number": 0,
33453339
"created_at": "2019-08-24T14:15:22Z",
33463340
"daily_cost": 0,
3347-
"deadline": {
3348-
"time": "string",
3349-
"valid": true
3350-
},
3341+
"deadline": "2019-08-24T14:15:22Z",
33513342
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
33523343
"initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
33533344
"initiator_name": "string",

‎docs/api/workspaces.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/member
3636
"build_number": 0,
3737
"created_at": "2019-08-24T14:15:22Z",
3838
"daily_cost": 0,
39-
"deadline": {
40-
"time": "string",
41-
"valid": true
42-
},
39+
"deadline": "2019-08-24T14:15:22Z",
4340
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
4441
"initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
4542
"initiator_name": "string",
@@ -200,10 +197,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam
200197
"build_number": 0,
201198
"created_at": "2019-08-24T14:15:22Z",
202199
"daily_cost": 0,
203-
"deadline": {
204-
"time": "string",
205-
"valid": true
206-
},
200+
"deadline": "2019-08-24T14:15:22Z",
207201
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
208202
"initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
209203
"initiator_name": "string",
@@ -387,10 +381,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
387381
"build_number": 0,
388382
"created_at": "2019-08-24T14:15:22Z",
389383
"daily_cost": 0,
390-
"deadline": {
391-
"time": "string",
392-
"valid": true
393-
},
384+
"deadline": "2019-08-24T14:15:22Z",
394385
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
395386
"initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
396387
"initiator_name": "string",
@@ -548,10 +539,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{id} \
548539
"build_number": 0,
549540
"created_at": "2019-08-24T14:15:22Z",
550541
"daily_cost": 0,
551-
"deadline": {
552-
"time": "string",
553-
"valid": true
554-
},
542+
"deadline": "2019-08-24T14:15:22Z",
555543
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
556544
"initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
557545
"initiator_name": "string",

‎scripts/apidocgen/markdown-template/main.dot

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@
55
}
66

77
const pRef = p.$ref.replace("#/components/schemas/","");
8-
if (pRef == "codersdk.NullTime") {
9-
return "string(time) or `null`";
10-
}
118
return "[" + pRef + "](#" + pRef.replace(".","").toLowerCase() + ")";
129
}
1310

0 commit comments

Comments
 (0)