9a9398b386
Adds Skooma-based OpenAPI validation so SDK-facing request specs can assert that documented request and response contracts match real Rails behavior. This also upgrades the spec to OpenAPI 3.1 and fixes contract drift uncovered while validating core application and platform resources. Closes None Why We want CI to catch OpenAPI drift before it reaches SDK consumers. While wiring validation in, this PR surfaced several mismatches between the documented contract and what the Rails endpoints actually accept or return. What this change does - Adds Skooma-backed OpenAPI validation to the request spec flow and a dedicated OpenAPI validation spec. - Migrates nullable schema definitions to OpenAPI 3.1-compatible unions. - Updates core SDK-facing schemas and payloads across accounts, contacts, conversations, inboxes, messages, teams, reporting events, and platform account resources. - Documents concrete runtime cases that were previously missing or inaccurate, including nested `profile` update payloads, multipart avatar uploads, required profile update bodies, nullable inbox feature flags, and message sender types that include both `Captain::Assistant` and senderless activity-style messages. - Regenerates the committed Swagger JSON and tag-group artifacts used by CI sync checks. Validation - `bundle exec rake swagger:build` - `bundle exec rspec spec/swagger/openapi_spec.rb` --------- Co-authored-by: Sojan Jose <sojan@pepalo.com>
114 lines
2.7 KiB
YAML
114 lines
2.7 KiB
YAML
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: ID of the message
|
|
content:
|
|
type: string
|
|
description: Content of the message
|
|
account_id:
|
|
type: integer
|
|
description: ID of the account
|
|
inbox_id:
|
|
type: integer
|
|
description: ID of the inbox
|
|
conversation_id:
|
|
type: integer
|
|
description: ID of the conversation
|
|
message_type:
|
|
type: integer
|
|
description: Type of the message
|
|
created_at:
|
|
type: integer
|
|
description: Timestamp when message was created
|
|
updated_at:
|
|
type: string
|
|
description: Formatted datetime when message was updated
|
|
private:
|
|
type: boolean
|
|
description: Whether the message is private
|
|
status:
|
|
type: string
|
|
description: Status of the message
|
|
source_id:
|
|
type:
|
|
- string
|
|
- 'null'
|
|
description: Source ID of the message
|
|
content_type:
|
|
type: string
|
|
description: Type of the content
|
|
content_attributes:
|
|
type: object
|
|
description: Attributes of the content
|
|
sender_type:
|
|
type:
|
|
- string
|
|
- 'null'
|
|
description: Type of the sender
|
|
sender_id:
|
|
type:
|
|
- integer
|
|
- 'null'
|
|
description: ID of the sender
|
|
external_source_ids:
|
|
type: object
|
|
description: External source IDs
|
|
additional_attributes:
|
|
type: object
|
|
description: Additional attributes of the message
|
|
processed_message_content:
|
|
type:
|
|
- string
|
|
- 'null'
|
|
description: Processed message content
|
|
sentiment:
|
|
type: object
|
|
description: Sentiment analysis of the message
|
|
conversation:
|
|
type: object
|
|
description: Conversation details
|
|
properties:
|
|
assignee_id:
|
|
type:
|
|
- integer
|
|
- 'null'
|
|
description: ID of the assignee
|
|
unread_count:
|
|
type: integer
|
|
description: Count of unread messages
|
|
last_activity_at:
|
|
type: integer
|
|
description: Timestamp of last activity
|
|
contact_inbox:
|
|
type: object
|
|
description: Contact inbox details
|
|
properties:
|
|
source_id:
|
|
type: string
|
|
description: Source ID of the contact inbox
|
|
sender:
|
|
type: object
|
|
description: Details of the sender
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: ID of the sender
|
|
name:
|
|
type: string
|
|
description: Name of the sender
|
|
available_name:
|
|
type: string
|
|
description: Available name of the sender
|
|
avatar_url:
|
|
type: string
|
|
description: URL of the sender's avatar
|
|
type:
|
|
type: string
|
|
description: Type of the sender
|
|
availability_status:
|
|
type: string
|
|
description: Availability status of the sender
|
|
thumbnail:
|
|
type: string
|
|
description: Thumbnail URL of the sender |