Files
craftlabs-authorization-sdk/contracts/openapi/delivery-platform-api.json
T
huangping d53ddf32c8 feat(i8-i9): webhook DEAD replay, read-only delivery status, and callback UI
I8: platform proxies replay to webhook; webhook ops token filter and internal
replay endpoint; delivery service supports read/replay flows.

I9: platform GET callback webhook delivery status by inbox id; UI shows
read-only status block and handles load errors without blocking the page.

Also refresh OpenAPI, Runbook notes, test fixtures and YAML; fix Vite dev
axios baseURL so /api uses proxy; improve login error messaging.

Made-with: Cursor
2026-04-07 21:26:44 +08:00

2658 lines
65 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{
"openapi" : "3.1.0",
"info" : {
"title" : "CraftLabs 交付管理平台 API",
"description" : "I1+JWT 认证;迭代扩展 M1M11",
"version" : "0.1.0-SNAPSHOT"
},
"servers" : [ {
"url" : "http://localhost",
"description" : "Generated server url"
} ],
"paths" : {
"/api/v1/projects/{id}" : {
"get" : {
"tags" : [ "project-controller" ],
"operationId" : "get",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProjectResponse"
}
}
}
}
}
},
"put" : {
"tags" : [ "project-controller" ],
"operationId" : "update",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProjectRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProjectResponse"
}
}
}
}
}
},
"delete" : {
"tags" : [ "project-controller" ],
"operationId" : "delete",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
},
"/api/v1/license-sns/{id}" : {
"get" : {
"tags" : [ "license-sn-controller" ],
"operationId" : "get_1",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/LicenseSnResponse"
}
}
}
}
}
},
"put" : {
"tags" : [ "license-sn-controller" ],
"operationId" : "update_1",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LicenseSnUpdateRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/LicenseSnResponse"
}
}
}
}
}
}
},
"/api/v1/delivery-batches/{id}" : {
"get" : {
"tags" : [ "delivery-batch-controller" ],
"operationId" : "get_2",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/DeliveryBatchResponse"
}
}
}
}
}
},
"put" : {
"tags" : [ "delivery-batch-controller" ],
"operationId" : "update_2",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeliveryBatchUpdateRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/DeliveryBatchResponse"
}
}
}
}
}
}
},
"/api/v1/delivery-batches/{id}/lines/{lineId}" : {
"put" : {
"tags" : [ "delivery-batch-controller" ],
"operationId" : "updateLine",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "lineId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeliveryLineRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/DeliveryLineResponse"
}
}
}
}
}
},
"delete" : {
"tags" : [ "delivery-batch-controller" ],
"operationId" : "deleteLine",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "lineId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
},
"/api/v1/customers/{id}" : {
"get" : {
"tags" : [ "customer-controller" ],
"operationId" : "get_3",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerResponse"
}
}
}
}
}
},
"put" : {
"tags" : [ "customer-controller" ],
"operationId" : "update_3",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerResponse"
}
}
}
}
}
},
"delete" : {
"tags" : [ "customer-controller" ],
"operationId" : "delete_1",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
},
"/api/v1/contracts/{id}" : {
"get" : {
"tags" : [ "contract-controller" ],
"operationId" : "get_4",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ContractResponse"
}
}
}
}
}
},
"put" : {
"tags" : [ "contract-controller" ],
"operationId" : "update_4",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContractUpdateRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ContractResponse"
}
}
}
}
}
}
},
"/api/v1/contracts/{id}/lines/{lineId}" : {
"put" : {
"tags" : [ "contract-controller" ],
"operationId" : "updateLine_1",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "lineId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContractLineRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ContractLineResponse"
}
}
}
}
}
},
"delete" : {
"tags" : [ "contract-controller" ],
"operationId" : "deleteLine_1",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "lineId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
},
"/api/v1/projects" : {
"get" : {
"tags" : [ "project-controller" ],
"operationId" : "list",
"parameters" : [ {
"name" : "page",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0,
"minimum" : 0
}
}, {
"name" : "size",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 200,
"minimum" : 1
}
}, {
"name" : "customerId",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/PageResponseProjectResponse"
}
}
}
}
}
},
"post" : {
"tags" : [ "project-controller" ],
"operationId" : "create",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProjectRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProjectResponse"
}
}
}
}
}
}
},
"/api/v1/license-sns" : {
"get" : {
"tags" : [ "license-sn-controller" ],
"operationId" : "list_1",
"parameters" : [ {
"name" : "page",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0,
"minimum" : 0
}
}, {
"name" : "size",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 200,
"minimum" : 1
}
}, {
"name" : "projectId",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "keyword",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "status",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/PageResponseLicenseSnResponse"
}
}
}
}
}
},
"post" : {
"tags" : [ "license-sn-controller" ],
"operationId" : "create_1",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LicenseSnCreateRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/LicenseSnResponse"
}
}
}
}
}
}
},
"/api/v1/delivery-batches" : {
"get" : {
"tags" : [ "delivery-batch-controller" ],
"operationId" : "list_2",
"parameters" : [ {
"name" : "page",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0,
"minimum" : 0
}
}, {
"name" : "size",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 200,
"minimum" : 1
}
}, {
"name" : "projectId",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "contractId",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "keyword",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/PageResponseDeliveryBatchResponse"
}
}
}
}
}
},
"post" : {
"tags" : [ "delivery-batch-controller" ],
"operationId" : "create_2",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeliveryBatchCreateRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/DeliveryBatchResponse"
}
}
}
}
}
}
},
"/api/v1/delivery-batches/{id}/lines" : {
"get" : {
"tags" : [ "delivery-batch-controller" ],
"operationId" : "listLines",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DeliveryLineResponse"
}
}
}
}
}
}
},
"post" : {
"tags" : [ "delivery-batch-controller" ],
"operationId" : "addLine",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeliveryLineRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/DeliveryLineResponse"
}
}
}
}
}
}
},
"/api/v1/customers" : {
"get" : {
"tags" : [ "customer-controller" ],
"operationId" : "list_3",
"parameters" : [ {
"name" : "page",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0,
"minimum" : 0
}
}, {
"name" : "size",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 200,
"minimum" : 1
}
}, {
"name" : "keyword",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/PageResponseCustomerResponse"
}
}
}
}
}
},
"post" : {
"tags" : [ "customer-controller" ],
"operationId" : "create_3",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerResponse"
}
}
}
}
}
}
},
"/api/v1/contracts" : {
"get" : {
"tags" : [ "contract-controller" ],
"operationId" : "list_4",
"parameters" : [ {
"name" : "page",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0,
"minimum" : 0
}
}, {
"name" : "size",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 200,
"minimum" : 1
}
}, {
"name" : "customerId",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "projectId",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "keyword",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/PageResponseContractResponse"
}
}
}
}
}
},
"post" : {
"tags" : [ "contract-controller" ],
"operationId" : "create_4",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContractCreateRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ContractResponse"
}
}
}
}
}
}
},
"/api/v1/contracts/{id}/lines" : {
"get" : {
"tags" : [ "contract-controller" ],
"operationId" : "listLines_1",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ContractLineResponse"
}
}
}
}
}
}
},
"post" : {
"tags" : [ "contract-controller" ],
"operationId" : "addLine_1",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContractLineRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ContractLineResponse"
}
}
}
}
}
}
},
"/api/v1/callback-inbox/{id}/replay-webhook-delivery" : {
"post" : {
"tags" : [ "callback-inbox-controller" ],
"operationId" : "replayWebhookDelivery",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/CallbackWebhookReplayResponse"
}
}
}
}
}
}
},
"/api/v1/auth/login" : {
"post" : {
"tags" : [ "auth-controller" ],
"operationId" : "login",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"type" : "object",
"additionalProperties" : { }
}
}
}
}
}
}
},
"/api/v1/license-sns/{id}/status" : {
"patch" : {
"tags" : [ "license-sn-controller" ],
"operationId" : "patchStatus",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LicenseSnStatusPatchRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/LicenseSnResponse"
}
}
}
}
}
}
},
"/api/v1/delivery-batches/{id}/status" : {
"patch" : {
"tags" : [ "delivery-batch-controller" ],
"operationId" : "patchStatus_1",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeliveryBatchStatusPatchRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/DeliveryBatchResponse"
}
}
}
}
}
}
},
"/api/v1/contracts/{id}/status" : {
"patch" : {
"tags" : [ "contract-controller" ],
"operationId" : "patchStatus_2",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContractStatusPatchRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ContractResponse"
}
}
}
}
}
}
},
"/api/v1/callback-inbox/{id}/status" : {
"patch" : {
"tags" : [ "callback-inbox-controller" ],
"operationId" : "patchStatus_3",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CallbackInboxStatusPatchRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/CallbackInboxResponse"
}
}
}
}
}
}
},
"/api/v1/callback-inbox/{id}/link" : {
"patch" : {
"tags" : [ "callback-inbox-controller" ],
"operationId" : "patchLink",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CallbackInboxLinkPatchRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/CallbackInboxResponse"
}
}
}
}
}
}
},
"/api/v1/ping" : {
"get" : {
"tags" : [ "ping-controller" ],
"operationId" : "ping",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
}
}
}
}
}
},
"/api/v1/integration/product-lines" : {
"get" : {
"tags" : [ "integration-catalog-controller" ],
"operationId" : "listProductLines",
"parameters" : [ {
"name" : "page",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0,
"minimum" : 0
}
}, {
"name" : "size",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 50,
"maximum" : 200,
"minimum" : 1
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/PageResponseProductLineResponse"
}
}
}
}
}
}
},
"/api/v1/integration/product-lines/{id}" : {
"get" : {
"tags" : [ "integration-catalog-controller" ],
"operationId" : "getProductLine",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProductLineResponse"
}
}
}
}
}
}
},
"/api/v1/integration/environments" : {
"get" : {
"tags" : [ "integration-catalog-controller" ],
"operationId" : "listEnvironments",
"parameters" : [ {
"name" : "page",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0,
"minimum" : 0
}
}, {
"name" : "size",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 50,
"maximum" : 200,
"minimum" : 1
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/PageResponseIntegrationEnvironmentResponse"
}
}
}
}
}
}
},
"/api/v1/integration/environments/{id}" : {
"get" : {
"tags" : [ "integration-catalog-controller" ],
"operationId" : "getEnvironment",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/IntegrationEnvironmentResponse"
}
}
}
}
}
}
},
"/api/v1/dictionaries/{type}" : {
"get" : {
"tags" : [ "dictionary-controller" ],
"operationId" : "listByType",
"parameters" : [ {
"name" : "type",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DictionaryItemResponse"
}
}
}
}
}
}
}
},
"/api/v1/callback-inbox" : {
"get" : {
"tags" : [ "callback-inbox-controller" ],
"operationId" : "list_5",
"parameters" : [ {
"name" : "page",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0,
"minimum" : 0
}
}, {
"name" : "size",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 200,
"minimum" : 1
}
}, {
"name" : "status",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "eventType",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "snCode",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "projectId",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "productLineId",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "environmentId",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "receivedFrom",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
}
}, {
"name" : "receivedTo",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/PageResponseCallbackInboxResponse"
}
}
}
}
}
}
},
"/api/v1/callback-inbox/{id}" : {
"get" : {
"tags" : [ "callback-inbox-controller" ],
"operationId" : "get_5",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/CallbackInboxResponse"
}
}
}
}
}
}
},
"/api/v1/callback-inbox/{id}/webhook-delivery" : {
"get" : {
"tags" : [ "callback-inbox-controller" ],
"operationId" : "getWebhookDelivery",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/CallbackWebhookDeliveryStatusResponse"
}
}
}
}
}
}
},
"/api/v1/audit-events" : {
"get" : {
"tags" : [ "audit-controller" ],
"operationId" : "list_6",
"parameters" : [ {
"name" : "entityType",
"in" : "query",
"required" : true,
"schema" : {
"type" : "string",
"minLength" : 1
}
}, {
"name" : "entityId",
"in" : "query",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "page",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0,
"minimum" : 0
}
}, {
"name" : "size",
"in" : "query",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"maximum" : 200,
"minimum" : 1
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/PageResponseAuditEventResponse"
}
}
}
}
}
}
}
},
"components" : {
"schemas" : {
"ProjectRequest" : {
"type" : "object",
"properties" : {
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string",
"maxLength" : 256,
"minLength" : 0
},
"phase" : {
"type" : "string",
"maxLength" : 64,
"minLength" : 0
}
},
"required" : [ "customerId", "name" ]
},
"ProjectResponse" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string"
},
"phase" : {
"type" : "string"
},
"createdAt" : {
"type" : "string",
"format" : "date-time"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time"
}
}
},
"LicenseSnUpdateRequest" : {
"type" : "object",
"properties" : {
"projectId" : {
"type" : "integer",
"format" : "int64"
},
"contractLineId" : {
"type" : "integer",
"format" : "int64"
},
"activationRemark" : {
"type" : "string",
"maxLength" : 512,
"minLength" : 0
}
}
},
"LicenseSnResponse" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"snCode" : {
"type" : "string"
},
"projectId" : {
"type" : "integer",
"format" : "int64"
},
"contractLineId" : {
"type" : "integer",
"format" : "int64"
},
"status" : {
"type" : "string"
},
"activationRemark" : {
"type" : "string"
},
"createdAt" : {
"type" : "string",
"format" : "date-time"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time"
}
}
},
"DeliveryBatchUpdateRequest" : {
"type" : "object",
"properties" : {
"plannedDeliveryDate" : {
"type" : "string"
},
"remarks" : {
"type" : "string",
"maxLength" : 4000,
"minLength" : 0
}
}
},
"DeliveryBatchResponse" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"projectId" : {
"type" : "integer",
"format" : "int64"
},
"contractId" : {
"type" : "integer",
"format" : "int64"
},
"batchCode" : {
"type" : "string"
},
"plannedDeliveryDate" : {
"type" : "string",
"format" : "date"
},
"status" : {
"type" : "string"
},
"finishedAt" : {
"type" : "string",
"format" : "date-time"
},
"remarks" : {
"type" : "string"
},
"createdAt" : {
"type" : "string",
"format" : "date-time"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time"
},
"lines" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DeliveryLineResponse"
}
}
}
},
"DeliveryLineResponse" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"batchId" : {
"type" : "integer",
"format" : "int64"
},
"sortOrder" : {
"type" : "integer",
"format" : "int32"
},
"description" : {
"type" : "string"
},
"quantity" : {
"type" : "number"
},
"contractLineId" : {
"type" : "integer",
"format" : "int64"
},
"createdAt" : {
"type" : "string",
"format" : "date-time"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time"
}
}
},
"DeliveryLineRequest" : {
"type" : "object",
"properties" : {
"sortOrder" : {
"type" : "integer",
"format" : "int32"
},
"description" : {
"type" : "string",
"maxLength" : 512,
"minLength" : 0
},
"quantity" : {
"type" : "number",
"minimum" : 1.0E-4
},
"contractLineId" : {
"type" : "integer",
"format" : "int64"
}
},
"required" : [ "description", "quantity" ]
},
"CustomerRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"maxLength" : 256,
"minLength" : 0
},
"creditCode" : {
"type" : "string",
"maxLength" : 64,
"minLength" : 0
},
"status" : {
"type" : "string",
"maxLength" : 32,
"minLength" : 0
}
},
"required" : [ "name" ]
},
"CustomerResponse" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string"
},
"creditCode" : {
"type" : "string"
},
"status" : {
"type" : "string"
},
"createdAt" : {
"type" : "string",
"format" : "date-time"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time"
}
}
},
"ContractUpdateRequest" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string",
"maxLength" : 256,
"minLength" : 0
},
"remarks" : {
"type" : "string",
"maxLength" : 4000,
"minLength" : 0
}
}
},
"ContractLineResponse" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"contractId" : {
"type" : "integer",
"format" : "int64"
},
"sortOrder" : {
"type" : "integer",
"format" : "int32"
},
"itemName" : {
"type" : "string"
},
"quantity" : {
"type" : "number"
},
"unit" : {
"type" : "string"
},
"amount" : {
"type" : "number"
},
"remark" : {
"type" : "string"
},
"createdAt" : {
"type" : "string",
"format" : "date-time"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time"
}
}
},
"ContractResponse" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"projectId" : {
"type" : "integer",
"format" : "int64"
},
"title" : {
"type" : "string"
},
"remarks" : {
"type" : "string"
},
"status" : {
"type" : "string"
},
"createdAt" : {
"type" : "string",
"format" : "date-time"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time"
},
"lines" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ContractLineResponse"
}
}
}
},
"ContractLineRequest" : {
"type" : "object",
"properties" : {
"sortOrder" : {
"type" : "integer",
"format" : "int32"
},
"itemName" : {
"type" : "string",
"maxLength" : 256,
"minLength" : 0
},
"quantity" : {
"type" : "number",
"minimum" : 1.0E-4
},
"unit" : {
"type" : "string",
"maxLength" : 32,
"minLength" : 0
},
"amount" : {
"type" : "number"
},
"remark" : {
"type" : "string",
"maxLength" : 512,
"minLength" : 0
}
},
"required" : [ "itemName", "quantity" ]
},
"LicenseSnCreateRequest" : {
"type" : "object",
"properties" : {
"snCode" : {
"type" : "string",
"maxLength" : 128,
"minLength" : 0
},
"projectId" : {
"type" : "integer",
"format" : "int64"
},
"contractLineId" : {
"type" : "integer",
"format" : "int64"
},
"activationRemark" : {
"type" : "string",
"maxLength" : 512,
"minLength" : 0
}
},
"required" : [ "snCode" ]
},
"DeliveryBatchCreateRequest" : {
"type" : "object",
"properties" : {
"projectId" : {
"type" : "integer",
"format" : "int64"
},
"contractId" : {
"type" : "integer",
"format" : "int64"
},
"batchCode" : {
"type" : "string",
"maxLength" : 64,
"minLength" : 0
},
"plannedDeliveryDate" : {
"type" : "string"
},
"remarks" : {
"type" : "string",
"maxLength" : 4000,
"minLength" : 0
}
},
"required" : [ "batchCode", "projectId" ]
},
"ContractCreateRequest" : {
"type" : "object",
"properties" : {
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"projectId" : {
"type" : "integer",
"format" : "int64"
},
"title" : {
"type" : "string",
"maxLength" : 256,
"minLength" : 0
},
"remarks" : {
"type" : "string",
"maxLength" : 4000,
"minLength" : 0
}
},
"required" : [ "customerId", "projectId" ]
},
"CallbackWebhookReplayResponse" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string"
},
"receiptId" : {
"type" : "string"
}
}
},
"LicenseSnStatusPatchRequest" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "status" ]
},
"DeliveryBatchStatusPatchRequest" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "status" ]
},
"ContractStatusPatchRequest" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "status" ]
},
"CallbackInboxStatusPatchRequest" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"minLength" : 1
}
},
"required" : [ "status" ]
},
"CallbackInboxResponse" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"sourceSystem" : {
"type" : "string"
},
"externalMessageId" : {
"type" : "string"
},
"schemaVersion" : {
"type" : "string"
},
"eventType" : {
"type" : "string"
},
"status" : {
"type" : "string"
},
"rawPayload" : {
"type" : "string"
},
"idempotencyKey" : {
"type" : "string"
},
"licenseSnId" : {
"type" : "integer",
"format" : "int64"
},
"projectId" : {
"type" : "integer",
"format" : "int64"
},
"contractId" : {
"type" : "integer",
"format" : "int64"
},
"snCode" : {
"type" : "string"
},
"productLineId" : {
"type" : "integer",
"format" : "int64"
},
"integrationEnvironmentId" : {
"type" : "integer",
"format" : "int64"
},
"receivedAt" : {
"type" : "string",
"format" : "date-time"
},
"processedAt" : {
"type" : "string",
"format" : "date-time"
},
"processedByUserId" : {
"type" : "string"
},
"failureReason" : {
"type" : "string"
},
"operatorNote" : {
"type" : "string"
},
"webhookReceiptId" : {
"type" : "string"
},
"createdAt" : {
"type" : "string",
"format" : "date-time"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time"
}
}
},
"CallbackInboxLinkPatchRequest" : {
"type" : "object",
"properties" : {
"licenseSnId" : {
"type" : "integer",
"format" : "int64"
},
"projectId" : {
"type" : "integer",
"format" : "int64"
},
"contractId" : {
"type" : "integer",
"format" : "int64"
}
}
},
"PageResponseProjectResponse" : {
"type" : "object",
"properties" : {
"content" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ProjectResponse"
}
},
"totalElements" : {
"type" : "integer",
"format" : "int64"
},
"number" : {
"type" : "integer",
"format" : "int32"
},
"size" : {
"type" : "integer",
"format" : "int32"
}
}
},
"PageResponseLicenseSnResponse" : {
"type" : "object",
"properties" : {
"content" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/LicenseSnResponse"
}
},
"totalElements" : {
"type" : "integer",
"format" : "int64"
},
"number" : {
"type" : "integer",
"format" : "int32"
},
"size" : {
"type" : "integer",
"format" : "int32"
}
}
},
"PageResponseProductLineResponse" : {
"type" : "object",
"properties" : {
"content" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ProductLineResponse"
}
},
"totalElements" : {
"type" : "integer",
"format" : "int64"
},
"number" : {
"type" : "integer",
"format" : "int32"
},
"size" : {
"type" : "integer",
"format" : "int32"
}
}
},
"ProductLineResponse" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"code" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"enabled" : {
"type" : "boolean"
},
"createdAt" : {
"type" : "string",
"format" : "date-time"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time"
}
}
},
"IntegrationEnvironmentResponse" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"code" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"bitanswerBaseUrl" : {
"type" : "string"
},
"kind" : {
"type" : "string"
},
"productLineId" : {
"type" : "integer",
"format" : "int64"
},
"createdAt" : {
"type" : "string",
"format" : "date-time"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time"
}
}
},
"PageResponseIntegrationEnvironmentResponse" : {
"type" : "object",
"properties" : {
"content" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IntegrationEnvironmentResponse"
}
},
"totalElements" : {
"type" : "integer",
"format" : "int64"
},
"number" : {
"type" : "integer",
"format" : "int32"
},
"size" : {
"type" : "integer",
"format" : "int32"
}
}
},
"DictionaryItemResponse" : {
"type" : "object",
"properties" : {
"dictCode" : {
"type" : "string"
},
"dictLabel" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer",
"format" : "int32"
}
}
},
"PageResponseDeliveryBatchResponse" : {
"type" : "object",
"properties" : {
"content" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DeliveryBatchResponse"
}
},
"totalElements" : {
"type" : "integer",
"format" : "int64"
},
"number" : {
"type" : "integer",
"format" : "int32"
},
"size" : {
"type" : "integer",
"format" : "int32"
}
}
},
"PageResponseCustomerResponse" : {
"type" : "object",
"properties" : {
"content" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerResponse"
}
},
"totalElements" : {
"type" : "integer",
"format" : "int64"
},
"number" : {
"type" : "integer",
"format" : "int32"
},
"size" : {
"type" : "integer",
"format" : "int32"
}
}
},
"PageResponseContractResponse" : {
"type" : "object",
"properties" : {
"content" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ContractResponse"
}
},
"totalElements" : {
"type" : "integer",
"format" : "int64"
},
"number" : {
"type" : "integer",
"format" : "int32"
},
"size" : {
"type" : "integer",
"format" : "int32"
}
}
},
"PageResponseCallbackInboxResponse" : {
"type" : "object",
"properties" : {
"content" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CallbackInboxResponse"
}
},
"totalElements" : {
"type" : "integer",
"format" : "int64"
},
"number" : {
"type" : "integer",
"format" : "int32"
},
"size" : {
"type" : "integer",
"format" : "int32"
}
}
},
"CallbackWebhookDeliveryStatusResponse" : {
"type" : "object",
"properties" : {
"receiptId" : {
"type" : "integer",
"format" : "int64"
},
"status" : {
"type" : "string"
},
"attempts" : {
"type" : "integer",
"format" : "int32"
},
"lastError" : {
"type" : "string"
},
"nextRetryAt" : {
"type" : "string",
"format" : "date-time"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time"
}
}
},
"AuditEventResponse" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"entityType" : {
"type" : "string"
},
"entityId" : {
"type" : "integer",
"format" : "int64"
},
"action" : {
"type" : "string"
},
"fieldName" : {
"type" : "string"
},
"oldValue" : {
"type" : "string"
},
"newValue" : {
"type" : "string"
},
"actorUserId" : {
"type" : "string"
},
"createdAt" : {
"type" : "string",
"format" : "date-time"
}
}
},
"PageResponseAuditEventResponse" : {
"type" : "object",
"properties" : {
"content" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AuditEventResponse"
}
},
"totalElements" : {
"type" : "integer",
"format" : "int64"
},
"number" : {
"type" : "integer",
"format" : "int32"
},
"size" : {
"type" : "integer",
"format" : "int32"
}
}
}
},
"securitySchemes" : {
"bearer-jwt" : {
"type" : "http",
"name" : "bearer-jwt",
"scheme" : "bearer",
"bearerFormat" : "JWT"
}
}
}
}