Files
sure/spec/swagger_helper.rb
soky srm 7be799fac7 Add categories endpoint in API (#460)
* Add categories endpoint in API

* FIX eager load parent and subcategories associations

* FIX update specs to match

* Add rswag spec

* FIX openapi spec

* FIX final warns
2025-12-17 15:00:01 +01:00

294 lines
10 KiB
Ruby

# frozen_string_literal: true
require 'rails_helper'
RSpec.configure do |config|
config.openapi_root = Rails.root.join('docs', 'api').to_s
config.openapi_specs = {
'openapi.yaml' => {
openapi: '3.0.3',
info: {
title: 'Sure API',
version: 'v1',
description: 'OpenAPI documentation generated from executable request specs.'
},
servers: [
{
url: 'https://api.sure.app',
description: 'Production'
},
{
url: 'http://localhost:3000',
description: 'Local development'
}
],
components: {
securitySchemes: {
bearerAuth: {
type: :http,
scheme: :bearer,
bearerFormat: :JWT
}
},
schemas: {
Pagination: {
type: :object,
required: %w[page per_page total_count total_pages],
properties: {
page: { type: :integer, minimum: 1 },
per_page: { type: :integer, minimum: 1 },
total_count: { type: :integer, minimum: 0 },
total_pages: { type: :integer, minimum: 0 }
}
},
ErrorResponse: {
type: :object,
required: %w[error],
properties: {
error: { type: :string },
message: { type: :string, nullable: true },
details: {
oneOf: [
{ type: :array, items: { type: :string } },
{ type: :object }
],
nullable: true
}
}
},
ToolCall: {
type: :object,
required: %w[id function_name function_arguments created_at],
properties: {
id: { type: :string, format: :uuid },
function_name: { type: :string },
function_arguments: { type: :object, additionalProperties: true },
function_result: { type: :object, additionalProperties: true, nullable: true },
created_at: { type: :string, format: :'date-time' }
}
},
Message: {
type: :object,
required: %w[id type role content created_at updated_at],
properties: {
id: { type: :string, format: :uuid },
type: { type: :string, enum: %w[user_message assistant_message] },
role: { type: :string, enum: %w[user assistant] },
content: { type: :string },
model: { type: :string, nullable: true },
created_at: { type: :string, format: :'date-time' },
updated_at: { type: :string, format: :'date-time' },
tool_calls: {
type: :array,
items: { '$ref' => '#/components/schemas/ToolCall' },
nullable: true
}
}
},
MessageResponse: {
allOf: [
{ '$ref' => '#/components/schemas/Message' },
{
type: :object,
required: %w[chat_id],
properties: {
chat_id: { type: :string, format: :uuid },
ai_response_status: { type: :string, enum: %w[pending complete failed], nullable: true },
ai_response_message: { type: :string, nullable: true }
}
}
]
},
ChatResource: {
type: :object,
required: %w[id title created_at updated_at],
properties: {
id: { type: :string, format: :uuid },
title: { type: :string },
error: { type: :string, nullable: true },
created_at: { type: :string, format: :'date-time' },
updated_at: { type: :string, format: :'date-time' }
}
},
ChatSummary: {
allOf: [
{ '$ref' => '#/components/schemas/ChatResource' },
{
type: :object,
required: %w[message_count],
properties: {
message_count: { type: :integer, minimum: 0 },
last_message_at: { type: :string, format: :'date-time', nullable: true }
}
}
]
},
ChatDetail: {
allOf: [
{ '$ref' => '#/components/schemas/ChatResource' },
{
type: :object,
required: %w[messages],
properties: {
messages: {
type: :array,
items: { '$ref' => '#/components/schemas/Message' }
},
pagination: {
'$ref' => '#/components/schemas/Pagination',
nullable: true
}
}
}
]
},
ChatCollection: {
type: :object,
required: %w[chats pagination],
properties: {
chats: {
type: :array,
items: { '$ref' => '#/components/schemas/ChatSummary' }
},
pagination: { '$ref' => '#/components/schemas/Pagination' }
}
},
RetryResponse: {
type: :object,
required: %w[message message_id],
properties: {
message: { type: :string },
message_id: { type: :string, format: :uuid }
}
},
Account: {
type: :object,
required: %w[id name account_type],
properties: {
id: { type: :string, format: :uuid },
name: { type: :string },
account_type: { type: :string }
}
},
Category: {
type: :object,
required: %w[id name classification color icon],
properties: {
id: { type: :string, format: :uuid },
name: { type: :string },
classification: { type: :string },
color: { type: :string },
icon: { type: :string }
}
},
CategoryParent: {
type: :object,
required: %w[id name],
properties: {
id: { type: :string, format: :uuid },
name: { type: :string }
}
},
CategoryDetail: {
type: :object,
required: %w[id name classification color icon subcategories_count created_at updated_at],
properties: {
id: { type: :string, format: :uuid },
name: { type: :string },
classification: { type: :string, enum: %w[income expense] },
color: { type: :string },
icon: { type: :string },
parent: { '$ref' => '#/components/schemas/CategoryParent', nullable: true },
subcategories_count: { type: :integer, minimum: 0 },
created_at: { type: :string, format: :'date-time' },
updated_at: { type: :string, format: :'date-time' }
}
},
CategoryCollection: {
type: :object,
required: %w[categories pagination],
properties: {
categories: {
type: :array,
items: { '$ref' => '#/components/schemas/CategoryDetail' }
},
pagination: { '$ref' => '#/components/schemas/Pagination' }
}
},
Merchant: {
type: :object,
required: %w[id name],
properties: {
id: { type: :string, format: :uuid },
name: { type: :string }
}
},
Tag: {
type: :object,
required: %w[id name color],
properties: {
id: { type: :string, format: :uuid },
name: { type: :string },
color: { type: :string }
}
},
Transfer: {
type: :object,
required: %w[id amount currency],
properties: {
id: { type: :string, format: :uuid },
amount: { type: :string },
currency: { type: :string },
other_account: { '$ref' => '#/components/schemas/Account', nullable: true }
}
},
Transaction: {
type: :object,
required: %w[id date amount currency name classification account tags created_at updated_at],
properties: {
id: { type: :string, format: :uuid },
date: { type: :string, format: :date },
amount: { type: :string },
currency: { type: :string },
name: { type: :string },
notes: { type: :string, nullable: true },
classification: { type: :string },
account: { '$ref' => '#/components/schemas/Account' },
category: { '$ref' => '#/components/schemas/Category', nullable: true },
merchant: { '$ref' => '#/components/schemas/Merchant', nullable: true },
tags: {
type: :array,
items: { '$ref' => '#/components/schemas/Tag' }
},
transfer: { '$ref' => '#/components/schemas/Transfer', nullable: true },
created_at: { type: :string, format: :'date-time' },
updated_at: { type: :string, format: :'date-time' }
}
},
TransactionCollection: {
type: :object,
required: %w[transactions pagination],
properties: {
transactions: {
type: :array,
items: { '$ref' => '#/components/schemas/Transaction' }
},
pagination: { '$ref' => '#/components/schemas/Pagination' }
}
},
DeleteResponse: {
type: :object,
required: %w[message],
properties: {
message: { type: :string }
}
}
}
}
}
}
config.openapi_format = :yaml
end