Разработана первая версия приложений
This commit is contained in:
mi
@@ -0,0 +1,314 @@
|
||||
openapi: 3.1.0
|
||||
info:
|
||||
title: HAN Chat API
|
||||
version: 1.0.0
|
||||
servers:
|
||||
- url: /
|
||||
paths:
|
||||
/health/live:
|
||||
get:
|
||||
operationId: healthLive
|
||||
responses:
|
||||
"200": {description: Process is live}
|
||||
/health/ready:
|
||||
get:
|
||||
operationId: healthReady
|
||||
responses:
|
||||
"200": {description: Ready or partially degraded}
|
||||
"503": {$ref: "#/components/responses/DependencyUnavailable"}
|
||||
/api/v1/public/app-config:
|
||||
get:
|
||||
operationId: getPublicAppConfig
|
||||
responses:
|
||||
"200": {description: Public application configuration}
|
||||
/api/v1/public/content:
|
||||
get:
|
||||
operationId: getPublicContent
|
||||
parameters:
|
||||
- {name: locale, in: query, schema: {type: string, default: ru}}
|
||||
responses:
|
||||
"200": {description: Active UI content}
|
||||
/api/v1/auth/bootstrap:
|
||||
post:
|
||||
operationId: bootstrap
|
||||
security: [{bearerAuth: []}]
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema: {$ref: "#/components/schemas/BootstrapRequest"}
|
||||
responses:
|
||||
"200": {description: Local user resolved}
|
||||
"401": {$ref: "#/components/responses/Unauthorized"}
|
||||
/api/v1/consents:
|
||||
post:
|
||||
operationId: recordConsents
|
||||
security: [{bearerAuth: []}]
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema: {$ref: "#/components/schemas/ConsentsRequest"}
|
||||
responses:
|
||||
"201": {description: Immutable consent records saved}
|
||||
/api/v1/analytics/session-start:
|
||||
post:
|
||||
operationId: startUxSession
|
||||
security: [{bearerAuth: []}]
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema: {$ref: "#/components/schemas/SessionStartRequest"}
|
||||
responses:
|
||||
"201": {description: UX session created}
|
||||
/api/v1/me:
|
||||
get:
|
||||
operationId: getCurrentProfile
|
||||
security: [{bearerAuth: []}]
|
||||
responses:
|
||||
"200": {description: Block profile}
|
||||
/api/v1/me/documents:
|
||||
get:
|
||||
operationId: listDocuments
|
||||
security: [{bearerAuth: []}]
|
||||
responses:
|
||||
"200": {description: Cursor-paginated documents}
|
||||
/api/v1/documents/{document_id}:
|
||||
parameters:
|
||||
- {$ref: "#/components/parameters/DocumentId"}
|
||||
get:
|
||||
operationId: getDocument
|
||||
security: [{bearerAuth: []}]
|
||||
responses:
|
||||
"200": {description: Document metadata}
|
||||
"404": {$ref: "#/components/responses/NotFound"}
|
||||
/api/v1/documents/{document_id}/download-url:
|
||||
parameters:
|
||||
- {$ref: "#/components/parameters/DocumentId"}
|
||||
get:
|
||||
operationId: getDocumentDownloadUrl
|
||||
security: [{bearerAuth: []}]
|
||||
responses:
|
||||
"200": {description: Short-lived presigned GET}
|
||||
/api/v1/dialogs:
|
||||
post:
|
||||
operationId: createDialog
|
||||
security: [{bearerAuth: []}]
|
||||
parameters:
|
||||
- {$ref: "#/components/parameters/IdempotencyKey"}
|
||||
responses:
|
||||
"200": {description: Existing active dialog}
|
||||
"201": {description: New active dialog}
|
||||
get:
|
||||
operationId: listDialogs
|
||||
security: [{bearerAuth: []}]
|
||||
responses:
|
||||
"200": {description: Cursor-paginated dialogs}
|
||||
/api/v1/dialogs/{dialog_id}:
|
||||
parameters:
|
||||
- {$ref: "#/components/parameters/DialogId"}
|
||||
get:
|
||||
operationId: getDialog
|
||||
security: [{bearerAuth: []}]
|
||||
responses:
|
||||
"200": {description: Dialog summary}
|
||||
"404": {$ref: "#/components/responses/NotFound"}
|
||||
/api/v1/dialogs/{dialog_id}/messages:
|
||||
parameters:
|
||||
- {$ref: "#/components/parameters/DialogId"}
|
||||
get:
|
||||
operationId: listMessages
|
||||
security: [{bearerAuth: []}]
|
||||
parameters:
|
||||
- {name: after, in: query, schema: {type: string}}
|
||||
- {name: limit, in: query, schema: {type: integer, minimum: 1, maximum: 100, default: 50}}
|
||||
responses:
|
||||
"200": {description: Message history or polling delta}
|
||||
post:
|
||||
operationId: sendMessage
|
||||
security: [{bearerAuth: []}]
|
||||
parameters:
|
||||
- {$ref: "#/components/parameters/IdempotencyKey"}
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- {$ref: "#/components/schemas/TextMessageRequest"}
|
||||
- {$ref: "#/components/schemas/FileMessageRequest"}
|
||||
discriminator: {propertyName: content_kind}
|
||||
responses:
|
||||
"201": {description: Safety-allowed and delivered message}
|
||||
"422": {description: Message blocked, content redacted}
|
||||
"503": {$ref: "#/components/responses/DependencyUnavailable"}
|
||||
/api/v1/dialogs/{dialog_id}/attachments/init:
|
||||
parameters:
|
||||
- {$ref: "#/components/parameters/DialogId"}
|
||||
post:
|
||||
operationId: initAttachment
|
||||
security: [{bearerAuth: []}]
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema: {$ref: "#/components/schemas/AttachmentInitRequest"}
|
||||
responses:
|
||||
"201": {description: Upload metadata and presigned PUT}
|
||||
/api/v1/dialogs/{dialog_id}/attachments/{attachment_id}/complete:
|
||||
parameters:
|
||||
- {$ref: "#/components/parameters/DialogId"}
|
||||
- {$ref: "#/components/parameters/AttachmentId"}
|
||||
post:
|
||||
operationId: completeAttachment
|
||||
security: [{bearerAuth: []}]
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema: {$ref: "#/components/schemas/ChecksumRequest"}
|
||||
responses:
|
||||
"200": {description: Upload metadata verified}
|
||||
/api/v1/dialogs/{dialog_id}/attachments/{attachment_id}/download-url:
|
||||
parameters:
|
||||
- {$ref: "#/components/parameters/DialogId"}
|
||||
- {$ref: "#/components/parameters/AttachmentId"}
|
||||
get:
|
||||
operationId: getAttachmentDownloadUrl
|
||||
security: [{bearerAuth: []}]
|
||||
responses:
|
||||
"200": {description: Audited short-lived presigned GET}
|
||||
/internal/openlines/v1/inbox:
|
||||
post:
|
||||
operationId: applyOpenLinesInbox
|
||||
security: [{serviceBearer: []}]
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema: {$ref: "#/components/schemas/OpenLinesInbox"}
|
||||
responses:
|
||||
"200": {description: Duplicate acknowledged}
|
||||
"201": {description: Event applied}
|
||||
/internal/settings/v1/otp:
|
||||
get:
|
||||
operationId: getOtpSettings
|
||||
security: [{serviceBearer: []}]
|
||||
responses:
|
||||
"200": {description: Product OTP limits and cache metadata}
|
||||
"503": {$ref: "#/components/responses/DependencyUnavailable"}
|
||||
components:
|
||||
securitySchemes:
|
||||
bearerAuth: {type: http, scheme: bearer, bearerFormat: JWT}
|
||||
serviceBearer: {type: http, scheme: bearer}
|
||||
parameters:
|
||||
DialogId: {name: dialog_id, in: path, required: true, schema: {type: string, format: uuid}}
|
||||
AttachmentId: {name: attachment_id, in: path, required: true, schema: {type: string, format: uuid}}
|
||||
DocumentId: {name: document_id, in: path, required: true, schema: {type: string, format: uuid}}
|
||||
IdempotencyKey: {name: Idempotency-Key, in: header, required: true, schema: {type: string, minLength: 1, maxLength: 128}}
|
||||
responses:
|
||||
Unauthorized:
|
||||
description: JWT is absent, invalid or expired
|
||||
content: {application/json: {schema: {$ref: "#/components/schemas/ErrorEnvelope"}}}
|
||||
NotFound:
|
||||
description: Resource absent or owned by another user
|
||||
content: {application/json: {schema: {$ref: "#/components/schemas/ErrorEnvelope"}}}
|
||||
DependencyUnavailable:
|
||||
description: Required dependency is unavailable
|
||||
content: {application/json: {schema: {$ref: "#/components/schemas/ErrorEnvelope"}}}
|
||||
schemas:
|
||||
ErrorEnvelope:
|
||||
type: object
|
||||
required: [error]
|
||||
properties:
|
||||
error:
|
||||
type: object
|
||||
required: [code, message, request_id, details]
|
||||
properties:
|
||||
code: {type: string}
|
||||
message: {type: string}
|
||||
request_id: {type: string}
|
||||
details: {type: object}
|
||||
ConsentChoice:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required: [accepted, version]
|
||||
properties:
|
||||
accepted: {type: boolean}
|
||||
version: {type: string, maxLength: 64}
|
||||
ConsentSet:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required: [personal_data, user_agreement, marketing]
|
||||
properties:
|
||||
personal_data: {$ref: "#/components/schemas/ConsentChoice"}
|
||||
user_agreement: {$ref: "#/components/schemas/ConsentChoice"}
|
||||
marketing: {$ref: "#/components/schemas/ConsentChoice"}
|
||||
Device:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required: [platform, app_version]
|
||||
properties:
|
||||
platform: {type: string, enum: [ios, android, web]}
|
||||
app_version: {type: string, maxLength: 64}
|
||||
device_id: {type: [string, "null"], maxLength: 255}
|
||||
BootstrapRequest:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required: [consents, device]
|
||||
properties:
|
||||
consents: {$ref: "#/components/schemas/ConsentSet"}
|
||||
device: {$ref: "#/components/schemas/Device"}
|
||||
ConsentsRequest:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required: [consents]
|
||||
properties: {consents: {$ref: "#/components/schemas/ConsentSet"}}
|
||||
SessionStartRequest:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required: [start_reason, device]
|
||||
properties:
|
||||
start_reason: {type: string, enum: [first_launch, cold_start, idle_timeout]}
|
||||
device: {$ref: "#/components/schemas/Device"}
|
||||
TextMessageRequest:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required: [content_kind, text]
|
||||
properties:
|
||||
content_kind: {const: text}
|
||||
text: {type: string, minLength: 1, maxLength: 4000}
|
||||
FileMessageRequest:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required: [content_kind, attachment_id, checksum]
|
||||
properties:
|
||||
content_kind: {const: file}
|
||||
attachment_id: {type: string, format: uuid}
|
||||
checksum: {type: string, pattern: "^sha256:[0-9a-f]{64}$"}
|
||||
AttachmentInitRequest:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required: [file_name, mime_type, size_bytes]
|
||||
properties:
|
||||
file_name: {type: string, minLength: 1, maxLength: 255}
|
||||
mime_type: {type: string, minLength: 1, maxLength: 128}
|
||||
size_bytes: {type: integer, minimum: 1}
|
||||
ChecksumRequest:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required: [checksum]
|
||||
properties:
|
||||
checksum: {type: string, pattern: "^sha256:[0-9a-f]{64}$"}
|
||||
OpenLinesInbox:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required: [event_id, event_type, external_chat_id, occurred_at]
|
||||
properties:
|
||||
event_id: {type: string, minLength: 1, maxLength: 255}
|
||||
event_type: {type: string, enum: [message.new, dialog.closed]}
|
||||
external_chat_id: {type: string, format: uuid}
|
||||
bitrix_message_id: {type: [string, "null"], maxLength: 255}
|
||||
occurred_at: {type: string, format: date-time}
|
||||
message: {type: [object, "null"]}
|
||||
Reference in New Issue
Block a user