Skip to content

Commit bb83aa4

Browse files
Eslam-NawaraEslam-Nawara
committed
update json format for account, node and farm
1 parent 3ef368c commit bb83aa4

File tree

5 files changed

+89
-351
lines changed

5 files changed

+89
-351
lines changed

‎node-registrar/docs/docs.go

Lines changed: 26 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -280,9 +280,12 @@ const docTemplate = `{
280280
],
281281
"responses": {
282282
"201": {
283-
"description": "Farm created successfully",
283+
"description": "'farm_id': farmID\"]",
284284
"schema": {
285-
"$ref": "#/definitions/db.Farm"
285+
"type": "object",
286+
"additionalProperties": {
287+
"type": "integer"
288+
}
286289
}
287290
},
288291
"400": {
@@ -533,9 +536,12 @@ const docTemplate = `{
533536
],
534537
"responses": {
535538
"201": {
536-
"description": "ID of the created node",
539+
"description": "'node_id': nodeID",
537540
"schema": {
538-
"type": "integer"
541+
"type": "object",
542+
"additionalProperties": {
543+
"type": "integer"
544+
}
539545
}
540546
},
541547
"400": {
@@ -853,7 +859,7 @@ const docTemplate = `{
853859
"db.Account": {
854860
"type": "object",
855861
"properties": {
856-
"createdAt": {
862+
"created_at": {
857863
"type": "string"
858864
},
859865
"farms": {
@@ -881,15 +887,15 @@ const docTemplate = `{
881887
"twin_id": {
882888
"type": "integer"
883889
},
884-
"updatedAt": {
890+
"updated_at": {
885891
"type": "string"
886892
}
887893
}
888894
},
889895
"db.Farm": {
890896
"type": "object",
891897
"properties": {
892-
"createdAt": {
898+
"created_at": {
893899
"type": "string"
894900
},
895901
"dedicated": {
@@ -912,7 +918,7 @@ const docTemplate = `{
912918
"description": "Farmer account reference",
913919
"type": "integer"
914920
},
915-
"updatedAt": {
921+
"updated_at": {
916922
"type": "string"
917923
}
918924
}
@@ -954,7 +960,7 @@ const docTemplate = `{
954960
"approved": {
955961
"type": "boolean"
956962
},
957-
"createdAt": {
963+
"created_at": {
958964
"type": "string"
959965
},
960966
"farm_id": {
@@ -981,17 +987,17 @@ const docTemplate = `{
981987
}
982988
]
983989
},
984-
"secureBoot": {
990+
"secure_boot": {
985991
"type": "boolean"
986992
},
987-
"serialNumber": {
993+
"serial_number": {
988994
"type": "string"
989995
},
990996
"twin_id": {
991997
"description": "Node account reference",
992998
"type": "integer"
993999
},
994-
"updatedAt": {
1000+
"updated_at": {
9951001
"type": "string"
9961002
},
9971003
"uptime": {
@@ -1025,7 +1031,7 @@ const docTemplate = `{
10251031
"db.UptimeReport": {
10261032
"type": "object",
10271033
"properties": {
1028-
"createdAt": {
1034+
"created_at": {
10291035
"type": "string"
10301036
},
10311037
"duration": {
@@ -1041,7 +1047,7 @@ const docTemplate = `{
10411047
"timestamp": {
10421048
"type": "string"
10431049
},
1044-
"wasRestart": {
1050+
"was_restart": {
10451051
"description": "True if this report followed a restart",
10461052
"type": "boolean"
10471053
}
@@ -1120,18 +1126,7 @@ const docTemplate = `{
11201126
}
11211127
},
11221128
"server.UpdateAccountRequest": {
1123-
"type": "object",
1124-
"properties": {
1125-
"relays": {
1126-
"type": "array",
1127-
"items": {
1128-
"type": "string"
1129-
}
1130-
},
1131-
"rmb_enc_key": {
1132-
"type": "string"
1133-
}
1134-
}
1129+
"type": "object"
11351130
},
11361131
"server.UpdateFarmRequest": {
11371132
"type": "object",
@@ -1184,19 +1179,7 @@ const docTemplate = `{
11841179
}
11851180
},
11861181
"server.UptimeReportRequest": {
1187-
"type": "object",
1188-
"required": [
1189-
"timestamp",
1190-
"uptime"
1191-
],
1192-
"properties": {
1193-
"timestamp": {
1194-
"type": "string"
1195-
},
1196-
"uptime": {
1197-
"$ref": "#/definitions/time.Duration"
1198-
}
1199-
}
1182+
"type": "object"
12001183
},
12011184
"server.ZOSVersionRequest": {
12021185
"type": "object",
@@ -1208,57 +1191,18 @@ const docTemplate = `{
12081191
"type": "string"
12091192
}
12101193
}
1211-
},
1212-
"time.Duration": {
1213-
"type": "integer",
1214-
"enum": [
1215-
-9223372036854775808,
1216-
9223372036854775807,
1217-
1,
1218-
1000,
1219-
1000000,
1220-
1000000000,
1221-
60000000000,
1222-
3600000000000,
1223-
-9223372036854775808,
1224-
9223372036854775807,
1225-
1,
1226-
1000,
1227-
1000000,
1228-
1000000000,
1229-
60000000000,
1230-
3600000000000
1231-
],
1232-
"x-enum-varnames": [
1233-
"minDuration",
1234-
"maxDuration",
1235-
"Nanosecond",
1236-
"Microsecond",
1237-
"Millisecond",
1238-
"Second",
1239-
"Minute",
1240-
"Hour",
1241-
"minDuration",
1242-
"maxDuration",
1243-
"Nanosecond",
1244-
"Microsecond",
1245-
"Millisecond",
1246-
"Second",
1247-
"Minute",
1248-
"Hour"
1249-
]
12501194
}
12511195
}
12521196
}`
12531197

12541198
// SwaggerInfo holds exported Swagger Info so clients can modify it
12551199
var SwaggerInfo = &swag.Spec{
1256-
Version: "1.0",
1200+
Version: "",
12571201
Host: "",
1258-
BasePath: "/v1",
1202+
BasePath: "",
12591203
Schemes: []string{},
1260-
Title: "Node Registrar API",
1261-
Description: "API for managing TFGrid node registration",
1204+
Title: "",
1205+
Description: "",
12621206
InfoInstanceName: "swagger",
12631207
SwaggerTemplate: docTemplate,
12641208
LeftDelim: "{{",

0 commit comments

Comments
 (0)