swagger: add show order, request address change, and approve address change api endpoint.

This commit is contained in:
weichien00
2021-08-19 01:35:23 +08:00
parent 6fb5d66631
commit e0405bca1e
+142
View File
@@ -2430,6 +2430,148 @@
}
}
},
"/order/show/{id}": {
"get": {
"tags": [
"Order"
],
"produces": [
"application/json"
],
"operationId": "showOrder",
"summary": "Show order",
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Order Reference Id",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {
"X-Expires-After": {
"type": "string",
"format": "date-time",
"description": "date in UTC when token expires"
},
"X-Rate-Limit": {
"type": "integer",
"format": "int32",
"description": "calls per hour allowed by the user"
}
},
"schema": {
"type": "string"
}
},
"422": {
"description": "Invalid input supplied"
}
}
}
},
"/order/address/change/request": {
"post": {
"tags": [
"Order"
],
"produces": [
"application/json"
],
"operationId": "requestChangeOrderAddress",
"summary": "Request Change Order Address",
"description": "",
"parameters": [
{
"name": "order_id",
"in": "query",
"description": "Order ID",
"required": true,
"type": "integer"
},
{
"name": "address_id",
"in": "query",
"description": "New Order Address ID",
"required": true,
"type": "integer"
},
],
"responses": {
"200": {
"description": "successful operation",
"headers": {
"X-Expires-After": {
"type": "string",
"format": "date-time",
"description": "date in UTC when token expires"
},
"X-Rate-Limit": {
"type": "integer",
"format": "int32",
"description": "calls per hour allowed by the user"
}
},
"schema": {
"type": "string"
}
},
"422": {
"description": "Invalid input supplied"
}
}
}
},
"/order/address/change/approve": {
"post": {
"tags": [
"Order"
],
"produces": [
"application/json"
],
"operationId": "approveChangeOrderAddress",
"summary": "Approve Change Order Address",
"description": "",
"parameters": [
{
"name": "order_id",
"in": "query",
"description": "Order ID",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {
"X-Expires-After": {
"type": "string",
"format": "date-time",
"description": "date in UTC when token expires"
},
"X-Rate-Limit": {
"type": "integer",
"format": "int32",
"description": "calls per hour allowed by the user"
}
},
"schema": {
"type": "string"
}
},
"422": {
"description": "Invalid input supplied"
}
}
}
},
"/address/create": {
"post": {
"tags": [