mirror of
https://github.com/we-promise/sure.git
synced 2026-04-07 14:31:25 +00:00
Add missing swagger for https://github.com/we-promise/sure/pull/501 (#707)
This commit is contained in:
soky srm
@@ -5,7 +5,7 @@ info:
|
||||
version: v1
|
||||
description: OpenAPI documentation generated from executable request specs.
|
||||
servers:
|
||||
- url: https://api.sure.app
|
||||
- url: https://app.sure.am
|
||||
description: Production
|
||||
- url: http://localhost:3000
|
||||
description: Local development
|
||||
@@ -416,6 +416,185 @@ components:
|
||||
properties:
|
||||
message:
|
||||
type: string
|
||||
ImportConfiguration:
|
||||
type: object
|
||||
properties:
|
||||
date_col_label:
|
||||
type: string
|
||||
nullable: true
|
||||
amount_col_label:
|
||||
type: string
|
||||
nullable: true
|
||||
name_col_label:
|
||||
type: string
|
||||
nullable: true
|
||||
category_col_label:
|
||||
type: string
|
||||
nullable: true
|
||||
tags_col_label:
|
||||
type: string
|
||||
nullable: true
|
||||
notes_col_label:
|
||||
type: string
|
||||
nullable: true
|
||||
account_col_label:
|
||||
type: string
|
||||
nullable: true
|
||||
date_format:
|
||||
type: string
|
||||
nullable: true
|
||||
number_format:
|
||||
type: string
|
||||
nullable: true
|
||||
signage_convention:
|
||||
type: string
|
||||
nullable: true
|
||||
ImportStats:
|
||||
type: object
|
||||
properties:
|
||||
rows_count:
|
||||
type: integer
|
||||
minimum: 0
|
||||
valid_rows_count:
|
||||
type: integer
|
||||
minimum: 0
|
||||
nullable: true
|
||||
ImportSummary:
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- type
|
||||
- status
|
||||
- created_at
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
format: uuid
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- TransactionImport
|
||||
- TradeImport
|
||||
- AccountImport
|
||||
- MintImport
|
||||
- CategoryImport
|
||||
- RuleImport
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- pending
|
||||
- complete
|
||||
- importing
|
||||
- reverting
|
||||
- revert_failed
|
||||
- failed
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
account_id:
|
||||
type: string
|
||||
format: uuid
|
||||
nullable: true
|
||||
rows_count:
|
||||
type: integer
|
||||
minimum: 0
|
||||
error:
|
||||
type: string
|
||||
nullable: true
|
||||
ImportDetail:
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- type
|
||||
- status
|
||||
- created_at
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
format: uuid
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- TransactionImport
|
||||
- TradeImport
|
||||
- AccountImport
|
||||
- MintImport
|
||||
- CategoryImport
|
||||
- RuleImport
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- pending
|
||||
- complete
|
||||
- importing
|
||||
- reverting
|
||||
- revert_failed
|
||||
- failed
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
account_id:
|
||||
type: string
|
||||
format: uuid
|
||||
nullable: true
|
||||
error:
|
||||
type: string
|
||||
nullable: true
|
||||
configuration:
|
||||
"$ref": "#/components/schemas/ImportConfiguration"
|
||||
stats:
|
||||
"$ref": "#/components/schemas/ImportStats"
|
||||
ImportCollection:
|
||||
type: object
|
||||
required:
|
||||
- data
|
||||
- meta
|
||||
properties:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
"$ref": "#/components/schemas/ImportSummary"
|
||||
meta:
|
||||
type: object
|
||||
required:
|
||||
- current_page
|
||||
- total_pages
|
||||
- total_count
|
||||
- per_page
|
||||
properties:
|
||||
current_page:
|
||||
type: integer
|
||||
minimum: 1
|
||||
next_page:
|
||||
type: integer
|
||||
nullable: true
|
||||
prev_page:
|
||||
type: integer
|
||||
nullable: true
|
||||
total_pages:
|
||||
type: integer
|
||||
minimum: 0
|
||||
total_count:
|
||||
type: integer
|
||||
minimum: 0
|
||||
per_page:
|
||||
type: integer
|
||||
minimum: 1
|
||||
ImportResponse:
|
||||
type: object
|
||||
required:
|
||||
- data
|
||||
properties:
|
||||
data:
|
||||
"$ref": "#/components/schemas/ImportDetail"
|
||||
paths:
|
||||
"/api/v1/categories":
|
||||
get:
|
||||
@@ -748,6 +927,197 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
"$ref": "#/components/schemas/ErrorResponse"
|
||||
"/api/v1/imports":
|
||||
get:
|
||||
summary: List imports
|
||||
description: List all imports for the user's family with pagination and filtering.
|
||||
tags:
|
||||
- Imports
|
||||
security:
|
||||
- bearerAuth: []
|
||||
parameters:
|
||||
- name: Authorization
|
||||
in: header
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Bearer token with read scope
|
||||
- name: page
|
||||
in: query
|
||||
required: false
|
||||
description: 'Page number (default: 1)'
|
||||
schema:
|
||||
type: integer
|
||||
- name: per_page
|
||||
in: query
|
||||
required: false
|
||||
description: 'Items per page (default: 25, max: 100)'
|
||||
schema:
|
||||
type: integer
|
||||
- name: status
|
||||
in: query
|
||||
required: false
|
||||
description: Filter by status
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- pending
|
||||
- complete
|
||||
- importing
|
||||
- reverting
|
||||
- revert_failed
|
||||
- failed
|
||||
- name: type
|
||||
in: query
|
||||
required: false
|
||||
description: Filter by import type
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- TransactionImport
|
||||
- TradeImport
|
||||
- AccountImport
|
||||
- MintImport
|
||||
- CategoryImport
|
||||
- RuleImport
|
||||
responses:
|
||||
'200':
|
||||
description: imports filtered by type
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
"$ref": "#/components/schemas/ImportCollection"
|
||||
post:
|
||||
summary: Create import
|
||||
description: Create a new import from raw CSV content.
|
||||
tags:
|
||||
- Imports
|
||||
security:
|
||||
- bearerAuth: []
|
||||
parameters:
|
||||
- name: Authorization
|
||||
in: header
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Bearer token with write scope
|
||||
responses:
|
||||
'201':
|
||||
description: import created
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
"$ref": "#/components/schemas/ImportResponse"
|
||||
'422':
|
||||
description: validation error - file too large
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
"$ref": "#/components/schemas/ErrorResponse"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
raw_file_content:
|
||||
type: string
|
||||
description: The raw CSV content as a string
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- TransactionImport
|
||||
- TradeImport
|
||||
- AccountImport
|
||||
- MintImport
|
||||
- CategoryImport
|
||||
- RuleImport
|
||||
description: Import type (defaults to TransactionImport)
|
||||
account_id:
|
||||
type: string
|
||||
format: uuid
|
||||
description: Account ID to import into
|
||||
publish:
|
||||
type: string
|
||||
description: Set to "true" to automatically queue for processing
|
||||
if configuration is valid
|
||||
date_col_label:
|
||||
type: string
|
||||
description: Header name for the date column
|
||||
amount_col_label:
|
||||
type: string
|
||||
description: Header name for the amount column
|
||||
name_col_label:
|
||||
type: string
|
||||
description: Header name for the transaction name column
|
||||
category_col_label:
|
||||
type: string
|
||||
description: Header name for the category column
|
||||
tags_col_label:
|
||||
type: string
|
||||
description: Header name for the tags column
|
||||
notes_col_label:
|
||||
type: string
|
||||
description: Header name for the notes column
|
||||
date_format:
|
||||
type: string
|
||||
description: Date format pattern (e.g., "%m/%d/%Y")
|
||||
number_format:
|
||||
type: string
|
||||
enum:
|
||||
- '1,234.56'
|
||||
- 1.234,56
|
||||
- 1 234,56
|
||||
- '1,234'
|
||||
description: Number format for parsing amounts
|
||||
signage_convention:
|
||||
type: string
|
||||
enum:
|
||||
- inflows_positive
|
||||
- inflows_negative
|
||||
description: How to interpret positive/negative amounts
|
||||
col_sep:
|
||||
type: string
|
||||
enum:
|
||||
- ","
|
||||
- ";"
|
||||
description: Column separator
|
||||
required: true
|
||||
"/api/v1/imports/{id}":
|
||||
parameters:
|
||||
- name: Authorization
|
||||
in: header
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Bearer token with read scope
|
||||
- name: id
|
||||
in: path
|
||||
required: true
|
||||
description: Import ID
|
||||
schema:
|
||||
type: string
|
||||
get:
|
||||
summary: Retrieve an import
|
||||
description: Retrieve detailed information about a specific import, including
|
||||
configuration and row statistics.
|
||||
tags:
|
||||
- Imports
|
||||
security:
|
||||
- bearerAuth: []
|
||||
responses:
|
||||
'200':
|
||||
description: import retrieved
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
"$ref": "#/components/schemas/ImportResponse"
|
||||
'404':
|
||||
description: import not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
"$ref": "#/components/schemas/ErrorResponse"
|
||||
"/api/v1/transactions":
|
||||
get:
|
||||
summary: List transactions
|
||||
|
||||
Reference in New Issue
Block a user