Skip to content

Add Swagger/OpenAPI Documentation for All CostFX API Endpoints #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
akisma merged 8 commits into from
Oct 18, 2025
Merged

Add Swagger/OpenAPI Documentation for All CostFX API Endpoints #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4a1c59a
Initial plan
Copilot Oct 18, 2025
17cbc21
Initial exploration - identify missing swagger dependencies and route…
Copilot Oct 18, 2025
4c915f8
Add Swagger documentation for restaurants, ingredients, recipes, and …
Copilot Oct 18, 2025
d8a1eaa
Add comprehensive Swagger documentation for all inventory endpoints
Copilot Oct 18, 2025
5d74fd3
Add Swagger documentation for all periods management endpoints
Copilot Oct 18, 2025
a023664
Add comprehensive Swagger documentation for variance and agents endpo…
Copilot Oct 18, 2025
629e429
Fix linting issues in periods.js - Final cleanup
Copilot Oct 18, 2025
f4e0056
Merge main branch - resolve conflicts in package.json, swagger.js, an…
Copilot Oct 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions backend/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@
"redis": "^4.7.0",
"sequelize": "^6.37.3",
"square": "^37.1.0",
"swagger-jsdoc": "^6.2.8",
"swagger-ui-express": "^5.0.1",
"uuid": "^10.0.0",
"winston": "^3.14.2"
},
Expand Down
84 changes: 79 additions & 5 deletions backend/src/config/swagger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,52 @@ const options = {
example: 'Detailed error description'
}
}
},
Restaurant: {
type: 'object',
properties: {
id: {
type: 'integer',
example: 1
},
name: {
type: 'string',
example: 'Demo Restaurant'
},
address: {
type: 'string',
example: '123 Main St'
},
city: {
type: 'string',
example: 'San Francisco'
},
state: {
type: 'string',
example: 'CA'
},
zipCode: {
type: 'string',
example: '94102'
},
phone: {
type: 'string',
example: '555-1234'
},
email: {
type: 'string',
format: 'email',
example: 'demo@restaurant.com'
},
createdAt: {
type: 'string',
format: 'date-time'
},
updatedAt: {
type: 'string',
format: 'date-time'
}
}
}
}
},
Expand All @@ -56,17 +102,45 @@ const options = {
name: 'Health',
description: 'Health check endpoints'
},
{
name: 'Square OAuth',
description: 'Square POS OAuth 2.0 authentication endpoints'
},
{
name: 'Restaurants',
description: 'Restaurant management endpoints'
},
{
name: 'Ingredients',
description: 'Ingredient catalog management endpoints'
},
{
name: 'Recipes',
description: 'Recipe management endpoints'
},
{
name: 'Inventory',
description: 'Inventory management endpoints'
description: 'Inventory tracking and optimization endpoints'
},
{
name: 'Sales',
description: 'Sales data management endpoints'
},
{
name: 'Periods',
description: 'Inventory period management endpoints'
},
{
name: 'Variance',
description: 'Variance analysis endpoints'
},
{
name: 'Agents',
description: 'AI agent endpoints for cost, forecast, and inventory analysis'
},
{
name: 'Square OAuth',
description: 'Square POS OAuth 2.0 authentication endpoints'
},
{
name: 'POS Sync',
description: 'POS data synchronization endpoints'
},
{
name: 'CSV Imports',
Expand Down
Loading