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>
99 lines
2.4 KiB
YAML
99 lines
2.4 KiB
YAML
get:
|
|
tags:
|
|
- Profile
|
|
operationId: fetchProfile
|
|
summary: Fetch user profile
|
|
description: Get the user profile details
|
|
security:
|
|
- userApiKey: []
|
|
responses:
|
|
'200':
|
|
description: Success
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/user'
|
|
'401':
|
|
description: Unauthorized
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/bad_request_error'
|
|
put:
|
|
tags:
|
|
- Profile
|
|
operationId: updateProfile
|
|
summary: Update user profile
|
|
description: Update the user profile details
|
|
security:
|
|
- userApiKey: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- profile
|
|
properties:
|
|
profile:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
email:
|
|
type: string
|
|
display_name:
|
|
type: string
|
|
message_signature:
|
|
type: string
|
|
phone_number:
|
|
type: string
|
|
current_password:
|
|
type: string
|
|
password:
|
|
type: string
|
|
password_confirmation:
|
|
type: string
|
|
ui_settings:
|
|
type: object
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- profile
|
|
properties:
|
|
profile:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
email:
|
|
type: string
|
|
display_name:
|
|
type: string
|
|
message_signature:
|
|
type: string
|
|
phone_number:
|
|
type: string
|
|
current_password:
|
|
type: string
|
|
password:
|
|
type: string
|
|
password_confirmation:
|
|
type: string
|
|
avatar:
|
|
type: string
|
|
format: binary
|
|
ui_settings:
|
|
type: object
|
|
responses:
|
|
'200':
|
|
description: Success
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/user'
|
|
'401':
|
|
description: Unauthorized
|