Skip to content

Commit 38600db

Browse files
ThingEngineergithub-actions[bot]
ThingEngineer
authored and
github-actions[bot]
committed
feat: update mgmt api docs
1 parent bd0e979 commit 38600db

File tree

2 files changed

+161
-161
lines changed

2 files changed

+161
-161
lines changed

‎apps/docs/spec/api_v1_openapi.json‎

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2204,6 +2204,37 @@
22042204
}
22052205
},
22062206
"/v1/projects/{ref}/functions": {
2207+
"get": {
2208+
"operationId": "v1-list-all-functions",
2209+
"summary": "List all functions",
2210+
"description": "Returns all functions you've previously added to the specified project.",
2211+
"parameters": [
2212+
{
2213+
"name": "ref",
2214+
"required": true,
2215+
"in": "path",
2216+
"description": "Project ref",
2217+
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
2218+
}
2219+
],
2220+
"responses": {
2221+
"200": {
2222+
"description": "",
2223+
"content": {
2224+
"application/json": {
2225+
"schema": {
2226+
"type": "array",
2227+
"items": { "$ref": "#/components/schemas/FunctionResponse" }
2228+
}
2229+
}
2230+
}
2231+
},
2232+
"403": { "description": "" },
2233+
"500": { "description": "Failed to retrieve project's functions" }
2234+
},
2235+
"tags": ["Edge Functions"],
2236+
"security": [{ "bearer": [] }]
2237+
},
22072238
"post": {
22082239
"operationId": "v1-create-a-function",
22092240
"summary": "Create a function",
@@ -2277,37 +2308,6 @@
22772308
},
22782309
"tags": ["Edge Functions"],
22792310
"security": [{ "bearer": [] }]
2280-
},
2281-
"get": {
2282-
"operationId": "v1-list-all-functions",
2283-
"summary": "List all functions",
2284-
"description": "Returns all functions you've previously added to the specified project.",
2285-
"parameters": [
2286-
{
2287-
"name": "ref",
2288-
"required": true,
2289-
"in": "path",
2290-
"description": "Project ref",
2291-
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
2292-
}
2293-
],
2294-
"responses": {
2295-
"200": {
2296-
"description": "",
2297-
"content": {
2298-
"application/json": {
2299-
"schema": {
2300-
"type": "array",
2301-
"items": { "$ref": "#/components/schemas/FunctionResponse" }
2302-
}
2303-
}
2304-
}
2305-
},
2306-
"403": { "description": "" },
2307-
"500": { "description": "Failed to retrieve project's functions" }
2308-
},
2309-
"tags": ["Edge Functions"],
2310-
"security": [{ "bearer": [] }]
23112311
}
23122312
},
23132313
"/v1/projects/{ref}/functions/{function_slug}": {
@@ -4506,17 +4506,6 @@
45064506
"properties": { "query": { "type": "string" } },
45074507
"required": ["query"]
45084508
},
4509-
"V1CreateFunctionBody": {
4510-
"type": "object",
4511-
"properties": {
4512-
"slug": { "type": "string", "pattern": "/^[A-Za-z0-9_-]+$/" },
4513-
"name": { "type": "string" },
4514-
"body": { "type": "string" },
4515-
"verify_jwt": { "type": "boolean" },
4516-
"compute_multiplier": { "type": "number", "minimum": 1, "maximum": 4 }
4517-
},
4518-
"required": ["slug", "name", "body"]
4519-
},
45204509
"FunctionResponse": {
45214510
"type": "object",
45224511
"properties": {
@@ -4535,6 +4524,17 @@
45354524
},
45364525
"required": ["version", "created_at", "updated_at", "id", "slug", "name", "status"]
45374526
},
4527+
"V1CreateFunctionBody": {
4528+
"type": "object",
4529+
"properties": {
4530+
"slug": { "type": "string", "pattern": "/^[A-Za-z0-9_-]+$/" },
4531+
"name": { "type": "string" },
4532+
"body": { "type": "string" },
4533+
"verify_jwt": { "type": "boolean" },
4534+
"compute_multiplier": { "type": "number", "minimum": 1, "maximum": 4 }
4535+
},
4536+
"required": ["slug", "name", "body"]
4537+
},
45384538
"FunctionSlugResponse": {
45394539
"type": "object",
45404540
"properties": {

‎apps/docs/spec/transforms/api_v1_openapi_deparsed.json‎

Lines changed: 119 additions & 119 deletions
Original file line numberDiff line numberDiff line change
@@ -8545,6 +8545,101 @@
85458545
}
85468546
},
85478547
"/v1/projects/{ref}/functions": {
8548+
"get": {
8549+
"operationId": "v1-list-all-functions",
8550+
"summary": "List all functions",
8551+
"description": "Returns all functions you've previously added to the specified project.",
8552+
"parameters": [
8553+
{
8554+
"name": "ref",
8555+
"required": true,
8556+
"in": "path",
8557+
"description": "Project ref",
8558+
"schema": {
8559+
"minLength": 20,
8560+
"maxLength": 20,
8561+
"type": "string"
8562+
}
8563+
}
8564+
],
8565+
"responses": {
8566+
"200": {
8567+
"description": "",
8568+
"content": {
8569+
"application/json": {
8570+
"schema": {
8571+
"type": "array",
8572+
"items": {
8573+
"type": "object",
8574+
"properties": {
8575+
"version": {
8576+
"type": "integer"
8577+
},
8578+
"created_at": {
8579+
"type": "integer",
8580+
"format": "int64"
8581+
},
8582+
"updated_at": {
8583+
"type": "integer",
8584+
"format": "int64"
8585+
},
8586+
"id": {
8587+
"type": "string"
8588+
},
8589+
"slug": {
8590+
"type": "string"
8591+
},
8592+
"name": {
8593+
"type": "string"
8594+
},
8595+
"status": {
8596+
"enum": ["ACTIVE", "REMOVED", "THROTTLED"],
8597+
"type": "string"
8598+
},
8599+
"verify_jwt": {
8600+
"type": "boolean"
8601+
},
8602+
"import_map": {
8603+
"type": "boolean"
8604+
},
8605+
"entrypoint_path": {
8606+
"type": "string"
8607+
},
8608+
"import_map_path": {
8609+
"type": "string"
8610+
},
8611+
"compute_multiplier": {
8612+
"type": "number"
8613+
}
8614+
},
8615+
"required": [
8616+
"version",
8617+
"created_at",
8618+
"updated_at",
8619+
"id",
8620+
"slug",
8621+
"name",
8622+
"status"
8623+
]
8624+
}
8625+
}
8626+
}
8627+
}
8628+
},
8629+
"403": {
8630+
"description": ""
8631+
},
8632+
"500": {
8633+
"description": "Failed to retrieve project's functions"
8634+
}
8635+
},
8636+
"tags": ["Edge Functions"],
8637+
"security": [
8638+
{
8639+
"bearer": []
8640+
}
8641+
]
8642+
},
85488643
"post": {
85498644
"operationId": "v1-create-a-function",
85508645
"summary": "Create a function",
@@ -8752,101 +8847,6 @@
87528847
"bearer": []
87538848
}
87548849
]
8755-
},
8756-
"get": {
8757-
"operationId": "v1-list-all-functions",
8758-
"summary": "List all functions",
8759-
"description": "Returns all functions you've previously added to the specified project.",
8760-
"parameters": [
8761-
{
8762-
"name": "ref",
8763-
"required": true,
8764-
"in": "path",
8765-
"description": "Project ref",
8766-
"schema": {
8767-
"minLength": 20,
8768-
"maxLength": 20,
8769-
"type": "string"
8770-
}
8771-
}
8772-
],
8773-
"responses": {
8774-
"200": {
8775-
"description": "",
8776-
"content": {
8777-
"application/json": {
8778-
"schema": {
8779-
"type": "array",
8780-
"items": {
8781-
"type": "object",
8782-
"properties": {
8783-
"version": {
8784-
"type": "integer"
8785-
},
8786-
"created_at": {
8787-
"type": "integer",
8788-
"format": "int64"
8789-
},
8790-
"updated_at": {
8791-
"type": "integer",
8792-
"format": "int64"
8793-
},
8794-
"id": {
8795-
"type": "string"
8796-
},
8797-
"slug": {
8798-
"type": "string"
8799-
},
8800-
"name": {
8801-
"type": "string"
8802-
},
8803-
"status": {
8804-
"enum": ["ACTIVE", "REMOVED", "THROTTLED"],
8805-
"type": "string"
8806-
},
8807-
"verify_jwt": {
8808-
"type": "boolean"
8809-
},
8810-
"import_map": {
8811-
"type": "boolean"
8812-
},
8813-
"entrypoint_path": {
8814-
"type": "string"
8815-
},
8816-
"import_map_path": {
8817-
"type": "string"
8818-
},
8819-
"compute_multiplier": {
8820-
"type": "number"
8821-
}
8822-
},
8823-
"required": [
8824-
"version",
8825-
"created_at",
8826-
"updated_at",
8827-
"id",
8828-
"slug",
8829-
"name",
8830-
"status"
8831-
]
8832-
}
8833-
}
8834-
}
8835-
}
8836-
},
8837-
"403": {
8838-
"description": ""
8839-
},
8840-
"500": {
8841-
"description": "Failed to retrieve project's functions"
8842-
}
8843-
},
8844-
"tags": ["Edge Functions"],
8845-
"security": [
8846-
{
8847-
"bearer": []
8848-
}
8849-
]
88508850
}
88518851
},
88528852
"/v1/projects/{ref}/functions/{function_slug}": {
@@ -14420,30 +14420,6 @@
1442014420
},
1442114421
"required": ["query"]
1442214422
},
14423-
"V1CreateFunctionBody": {
14424-
"type": "object",
14425-
"properties": {
14426-
"slug": {
14427-
"type": "string",
14428-
"pattern": "/^[A-Za-z0-9_-]+$/"
14429-
},
14430-
"name": {
14431-
"type": "string"
14432-
},
14433-
"body": {
14434-
"type": "string"
14435-
},
14436-
"verify_jwt": {
14437-
"type": "boolean"
14438-
},
14439-
"compute_multiplier": {
14440-
"type": "number",
14441-
"minimum": 1,
14442-
"maximum": 4
14443-
}
14444-
},
14445-
"required": ["slug", "name", "body"]
14446-
},
1444714423
"FunctionResponse": {
1444814424
"type": "object",
1444914425
"properties": {
@@ -14489,6 +14465,30 @@
1448914465
},
1449014466
"required": ["version", "created_at", "updated_at", "id", "slug", "name", "status"]
1449114467
},
14468+
"V1CreateFunctionBody": {
14469+
"type": "object",
14470+
"properties": {
14471+
"slug": {
14472+
"type": "string",
14473+
"pattern": "/^[A-Za-z0-9_-]+$/"
14474+
},
14475+
"name": {
14476+
"type": "string"
14477+
},
14478+
"body": {
14479+
"type": "string"
14480+
},
14481+
"verify_jwt": {
14482+
"type": "boolean"
14483+
},
14484+
"compute_multiplier": {
14485+
"type": "number",
14486+
"minimum": 1,
14487+
"maximum": 4
14488+
}
14489+
},
14490+
"required": ["slug", "name", "body"]
14491+
},
1449214492
"FunctionSlugResponse": {
1449314493
"type": "object",
1449414494
"properties": {

0 commit comments

Comments
 (0)