61 lines
6.9 KiB
YAML
61 lines
6.9 KiB
YAML
|
openapi: 3.0.3
|
|||
|
|
info: {title: Firstleg Container Overview API, version: 1.0.0}
|
|||
|
|
paths:
|
|||
|
|
/api/platform/v1/containers/{id}/overview:
|
|||
|
|
get:
|
|||
|
|
operationId: getContainerOverview
|
|||
|
|
description: '权限：platform:firstleg:container:list'
|
|||
|
|
parameters: [{$ref: '#/components/parameters/ContainerId'}]
|
|||
|
|
responses: {'200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/OverviewEnvelope'}}}}}
|
|||
|
|
/api/platform/v1/containers/{id}/exception:
|
|||
|
|
parameters: [{$ref: '#/components/parameters/ContainerId'}]
|
|||
|
|
post: {operationId: markContainerException, description: '权限：platform:firstleg:container:edit', parameters: [{name: Idempotency-Key, in: header, required: true, schema: {type: string, minLength: 1, maxLength: 128}}], requestBody: {$ref: '#/components/requestBodies/ExceptionRequest'}, responses: {'200': {description: OK}}}
|
|||
|
|
delete: {operationId: cancelContainerException, description: '权限：platform:firstleg:container:edit', parameters: [{name: Idempotency-Key, in: header, required: true, schema: {type: string, minLength: 1, maxLength: 128}}], requestBody: {$ref: '#/components/requestBodies/ExceptionRequest'}, responses: {'200': {description: OK}}}
|
|||
|
|
/api/platform/v1/containers/{id}/documents/{documentType}:
|
|||
|
|
get:
|
|||
|
|
operationId: getContainerDocument
|
|||
|
|
description: '权限：platform:firstleg:container:list；仅DO/PU，completed恒为false'
|
|||
|
|
parameters: [{$ref: '#/components/parameters/ContainerId'}, {$ref: '#/components/parameters/DocumentType'}]
|
|||
|
|
responses: {'200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/DocumentEnvelope'}}}}}
|
|||
|
|
/api/platform/v1/containers/{id}/documents/{documentType}/upload:
|
|||
|
|
post:
|
|||
|
|
operationId: uploadContainerDocument
|
|||
|
|
description: '权限：platform:firstleg:container:edit；仅DO/PU，无完成动作'
|
|||
|
|
parameters: [{$ref: '#/components/parameters/ContainerId'}, {$ref: '#/components/parameters/DocumentType'}, {name: Idempotency-Key, in: header, required: true, schema: {type: string}}]
|
|||
|
|
requestBody: {required: true, content: {multipart/form-data: {schema: {type: object, required: [file, expectedVersion], properties: {file: {type: string, format: binary}, expectedVersion: {type: integer, minimum: 0}, operationReason: {type: string, maxLength: 500}}}}}}
|
|||
|
|
responses: {'200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/DocumentEnvelope'}}}}}
|
|||
|
|
/api/platform/v1/containers/{id}/documents/{documentType}/{fileId}/download:
|
|||
|
|
get:
|
|||
|
|
operationId: downloadContainerDocument
|
|||
|
|
description: '权限：platform:firstleg:container:list；Firstleg代理File内部下载，不向调用方暴露内部令牌'
|
|||
|
|
parameters: [{$ref: '#/components/parameters/ContainerId'}, {$ref: '#/components/parameters/DocumentType'}, {name: fileId, in: path, required: true, schema: {type: integer, format: int64}}]
|
|||
|
|
responses: {'200': {description: file bytes, content: {application/octet-stream: {schema: {type: string, format: binary}}}}}
|
|||
|
|
components:
|
|||
|
|
parameters:
|
|||
|
|
ContainerId: {name: id, in: path, required: true, schema: {type: integer, format: int64}}
|
|||
|
|
DocumentType: {name: documentType, in: path, required: true, schema: {type: string, enum: [DELIVERY_ORDER, PICKUP_ORDER]}, description: '通用单证仅支持DO/PU；清关使用 /clearance，出口报关使用 loading-list 专用接口'}
|
|||
|
|
requestBodies:
|
|||
|
|
ExceptionRequest: {required: true, content: {application/json: {schema: {$ref: '#/components/schemas/ExceptionRequest'}}}}
|
|||
|
|
schemas:
|
|||
|
|
OverviewEnvelope: {type: object, properties: {code: {type: string}, message: {type: string}, data: {$ref: '#/components/schemas/Overview'}}}
|
|||
|
|
DocumentEnvelope: {type: object, properties: {code: {type: string}, message: {type: string}, data: {$ref: '#/components/schemas/Document'}}}
|
|||
|
|
Overview:
|
|||
|
|
type: object
|
|||
|
|
properties:
|
|||
|
|
container: {$ref: '#/components/schemas/Container'}
|
|||
|
|
loadingPlanId: {type: integer, format: int64}
|
|||
|
|
pda: {$ref: '#/components/schemas/PdaSummary'}
|
|||
|
|
documents: {type: array, items: {$ref: '#/components/schemas/Document'}}
|
|||
|
|
exception: {$ref: '#/components/schemas/ExceptionState'}
|
|||
|
|
exceptionHistory: {type: array, items: {$ref: '#/components/schemas/ExceptionHistory'}}
|
|||
|
|
timeline: {type: array, items: {$ref: '#/components/schemas/TimelineEntry'}}
|
|||
|
|
Container: {type: object, properties: {id: {type: integer, format: int64}, bookingNo: {type: string}, cabinetNo: {type: string}, containerNo: {type: string}, status: {type: string}, warehouseId: {type: integer, format: int64}, warehouseName: {type: string}, voyageNo: {type: string}, vesselName: {type: string}, version: {type: integer, minimum: 0}}}
|
|||
|
|
PdaSummary: {type: object, properties: {taskId: {type: integer, format: int64}, loadingPlanId: {type: integer, format: int64}, containerBookingId: {type: integer, format: int64}, taskStatus: {type: string}, taskVersion: {type: integer}, itemCount: {type: integer}, completedItemCount: {type: integer}, unresolvedItemCount: {type: integer}, photoCounts: {type: array, items: {$ref: '#/components/schemas/PhotoCount'}}, photos: {type: array, items: {$ref: '#/components/schemas/Photo'}}, exceptionReasons: {type: array, items: {type: string}}}}
|
|||
|
|
PhotoCount: {type: object, properties: {evidenceType: {type: string}, count: {type: integer}}}
|
|||
|
|
Photo: {type: object, properties: {evidenceId: {type: integer, format: int64}, tenantId: {type: integer, format: int64}, inboundId: {type: integer, format: int64}, evidenceType: {type: string}, fileId: {type: integer, format: int64}, fileName: {type: string}, status: {type: string}, downloadPath: {type: string}, uploadedAt: {type: string, format: date-time}}}
|
|||
|
|
Document: {type: object, properties: {id: {type: integer, format: int64}, documentType: {type: string}, fileId: {type: integer, format: int64}, fileName: {type: string}, fileHash: {type: string}, uploadedBy: {type: integer, format: int64}, uploadedByName: {type: string}, uploadedAt: {type: string, format: date-time}, version: {type: integer}, completed: {type: boolean}}}
|
|||
|
|
ExceptionState: {type: object, properties: {active: {type: boolean}, reason: {type: string}, markedBy: {type: integer, format: int64}, markedByName: {type: string}, markedAt: {type: string, format: date-time}}}
|
|||
|
|
ExceptionHistory: {type: object, properties: {id: {type: integer, format: int64}, action: {type: string, enum: [MARK, CANCEL]}, reason: {type: string}, operatorId: {type: integer, format: int64}, operatorName: {type: string}, occurredAt: {type: string, format: date-time}}}
|
|||
|
|
TimelineEntry: {type: object, properties: {eventType: {type: string}, detail: {type: string}, operatorId: {type: integer, format: int64}, operatorName: {type: string}, occurredAt: {type: string, format: date-time}}}
|
|||
|
|
ExceptionRequest: {type: object, required: [expectedVersion, reason], properties: {expectedVersion: {type: integer, minimum: 0}, reason: {type: string, maxLength: 500}}}
|