1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# Accounting Module - OpenAPI Index
# Version: 3.0
#
# This file aggregates all OpenAPI specifications for the module.
# Individual entity specs are generated by `backbone schema generate`.
openapi: 3.0.3
info:
title: Accounting API
description: |
REST API for the accounting bounded context.
## Authentication
All endpoints require authentication via Bearer token.
## Standard Endpoints
Each entity has 12 standard CRUD endpoints:
- `GET /api/v1/{collection}` - List with pagination
- `POST /api/v1/{collection}` - Create
- `GET /api/v1/{collection}/:id` - Get by ID
- `PUT /api/v1/{collection}/:id` - Full update
- `PATCH /api/v1/{collection}/:id` - Partial update
- `DELETE /api/v1/{collection}/:id` - Soft delete
- `POST /api/v1/{collection}/bulk` - Bulk create
- `POST /api/v1/{collection}/upsert` - Upsert
- `GET /api/v1/{collection}/trash` - List deleted
- `POST /api/v1/{collection}/:id/restore` - Restore
- `DELETE /api/v1/{collection}/empty` - Empty trash
- `GET /api/v1/{collection}/count` - Count records
version: "1.0.0"
contact:
name: API Support
email: support@example.com
servers:
- url: http://localhost:3000
description: Development server
- url: https://api.example.com
description: Production server
tags:
# - name: Example
# description: Example entity operations
paths:
# Generated by backbone schema generate
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
Error:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
details:
type: object
Pagination:
type: object
properties:
page:
type: integer
minimum: 1
default: 1
page_size:
type: integer
minimum: 1
maximum: 100
default: 20
total:
type: integer
total_pages:
type: integer
security:
- bearerAuth: