Skip to content

Refactor openapi.yaml #332

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
merged 6 commits into from
Sep 21, 2025
Merged

Refactor openapi.yaml #332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ba99d2b
format and adding variable server URL
Ja4V8s28Ck Sep 18, 2025
bfc6338
removed requestBody from GET all boards
Ja4V8s28Ck Sep 18, 2025
57dc4ec
add CORS support for api-reference
Ja4V8s28Ck Sep 18, 2025
4577349
refactor and add authorization
Ja4V8s28Ck Sep 18, 2025
f5f34a7
remove request body for 'POST /auth/email/verify'
Ja4V8s28Ck Sep 18, 2025
53e900e
fix
Ja4V8s28Ck Sep 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
134 changes: 49 additions & 85 deletions content/api-reference/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,18 @@ info:
name: CodeCarrot
email: logchimp@codecarrot.net
servers:
- url: https://api.<your-domain>.com/api/v1
description: ""
- url: '{protocol}://{host-with-port}/api/v1'
description: "API URL"
variables:
protocol:
enum:
- 'http'
- 'https'
default: 'http'
host-with-port:
default: 'localhost:8000'
security:
- bearerAuth: []
tags:
- name: auth
description: "Endpoints related to account authentication via email and password"
Expand All @@ -32,7 +42,6 @@ tags:
description: "Endpoints related to roles and permissions"
- name: settings
description: "Endpoints related to LogChimp settings"

paths:
/auth/login:
post:
Expand All @@ -41,13 +50,10 @@ paths:
summary: Login
description: 'Login to account using email and password.'
operationId: userSignin
parameters:
- $ref: '#/components/parameters/contentTypeJson'
- $ref: '#/components/parameters/origin'
requestBody:
$ref: '#/components/requestBodies/Login'
responses:
200:
'200':
description: ''
content:
application/json:
Expand All @@ -60,7 +66,7 @@ paths:
headers:
Content-Type:
$ref: '#/components/headers/contentTypeJson'
400:
'400':
description: Bad Request
content:
application/json:
Expand Down Expand Up @@ -90,7 +96,7 @@ paths:
headers:
Content-Type:
$ref: '#/components/headers/contentTypeJson'
500:
'500':
$ref: "#/components/responses/InternalServerError"
headers:
Content-Type:
Expand All @@ -103,13 +109,10 @@ paths:
summary: Sign up
description: Create a new user account.
operationId: userSignup
parameters:
- $ref: '#/components/parameters/contentTypeJson'
- $ref: '#/components/parameters/origin'
requestBody:
$ref: '#/components/requestBodies/Login'
responses:
201:
'201':
description: ''
content:
application/json:
Expand All @@ -122,7 +125,7 @@ paths:
headers:
Content-Type:
$ref: '#/components/headers/contentTypeJson'
400:
'400':
description: Bad Request
content:
application/json:
Expand Down Expand Up @@ -150,24 +153,21 @@ paths:
headers:
Content-Type:
$ref: '#/components/headers/contentTypeJson'
500:
'500':
$ref: "#/components/responses/InternalServerError"
headers:
Content-Type:
$ref: '#/components/headers/contentTypeJson'
security: [ ]
security: []
/auth/setup:
get:
tags:
- auth
summary: Site setup
description: 'Get site setup information.'
operationId: getSiteSetup
parameters:
- $ref: '#/components/parameters/contentTypeJson'
- $ref: '#/components/parameters/origin'
responses:
200:
'200':
description: ''
content:
application/json:
Expand All @@ -180,7 +180,7 @@ paths:
headers:
Content-Type:
$ref: '#/components/headers/contentTypeJson'
500:
'500':
$ref: "#/components/responses/InternalServerError"
headers:
Content-Type:
Expand All @@ -192,9 +192,6 @@ paths:
summary: Site setup
description: 'Setup the site by creating the owner account.'
operationId: siteSetup
parameters:
- $ref: '#/components/parameters/contentTypeJson'
- $ref: '#/components/parameters/origin'
requestBody:
description: ''
content:
Expand All @@ -213,7 +210,7 @@ paths:
example: "Mike"
required: true
responses:
200:
'200':
description: ''
content:
application/json:
Expand All @@ -226,7 +223,7 @@ paths:
headers:
Content-Type:
$ref: '#/components/headers/contentTypeJson'
400:
'400':
description: Bad Request
content:
application/json:
Expand Down Expand Up @@ -254,7 +251,7 @@ paths:
headers:
Content-Type:
$ref: '#/components/headers/contentTypeJson'
500:
'500':
$ref: "#/components/responses/InternalServerError"
headers:
Content-Type:
Expand Down Expand Up @@ -292,15 +289,8 @@ paths:
type: string
default: application/json
description: ""
requestBody:
description: Get all the boards
content:
application/json:
schema:
type: object
required: false
responses:
200:
'200':
description: ""
content:
application/json:
Expand All @@ -315,12 +305,12 @@ paths:
headers:
Content-Type:
$ref: '#/components/headers/contentTypeJson'
500:
'500':
$ref: "#/components/responses/InternalServerError"
headers:
Content-Type:
$ref: '#/components/headers/contentTypeJson'
security: [ ]
security: []
/auth/email/verify:
post:
tags:
Expand All @@ -330,23 +320,8 @@ paths:
Send a verification email to the user email address.
The email is only sent if have configured [SMTP mail server](https://docs.logchimp.codecarrot.net/docs/environment-variables#mail) are configured at the time of deploying LogChimp.
operationId: sendVerificationEmail
parameters:
- $ref: '#/components/parameters/contentTypeJson'
- $ref: '#/components/parameters/origin'
requestBody:
description: ''
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
example: "mike@example.com"
required: true
responses:
200:
'200':
description: ''
content:
application/json:
Expand All @@ -362,7 +337,7 @@ paths:
headers:
Content-Type:
$ref: '#/components/headers/contentTypeJson'
400:
'400':
description: Bad Request
content:
application/json:
Expand All @@ -376,40 +351,29 @@ paths:
headers:
Content-Type:
$ref: '#/components/headers/contentTypeJson'
500:
'500':
$ref: "#/components/responses/InternalServerError"
headers:
Content-Type:
$ref: '#/components/headers/contentTypeJson'
security: [ ]
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: JWT Bearer token authentication
headers:
contentTypeJson:
description: ''
schema:
type: string
example: application/json
parameters:
contentTypeJson:
name: Content-Type
in: header
schema:
type: string
default: application/json
description: ''
origin:
name: origin
in: header
schema:
type: string
default: 'https://example.com'
description: ''
schemas:
UserBlockedErrorCode:
type: object
required:
- message
- code
- message
- code
properties:
message:
type: string
Expand All @@ -420,8 +384,8 @@ components:
InvalidUserIdErrorCode:
type: object
required:
- message
- code
- message
- code
properties:
message:
type: string
Expand All @@ -432,8 +396,8 @@ components:
UserNotFoundErrorCode:
type: object
required:
- message
- code
- message
- code
properties:
message:
type: string
Expand All @@ -444,8 +408,8 @@ components:
EmailInvalidErrorCode:
type: object
required:
- message
- code
- message
- code
properties:
message:
type: string
Expand All @@ -456,8 +420,8 @@ components:
EmailVerifiedErrorCode:
type: object
required:
- message
- code
- message
- code
properties:
message:
type: string
Expand All @@ -468,8 +432,8 @@ components:
MailConfigurationErrorCode:
type: object
required:
- message
- code
- message
- code
properties:
message:
type: string
Expand All @@ -483,7 +447,7 @@ components:
boardId:
type: string
format: uuid
example:
example: 11c14790-b4d3-4689-942c-55548cfdd8a6
name:
type: string
example: "🔗 Integrations"
Expand All @@ -499,7 +463,7 @@ components:
format: date-time
BoardDetail:
allOf:
- $ref: "#/components/schemas/Board"
- $ref: "#/components/schemas/Board"
- type: object
properties:
post_count:
Expand Down
9 changes: 5 additions & 4 deletions next.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ const config = {
// Reduce bundle size by optimizing package imports for lucide-react
optimizePackageImports: ["lucide-react"],
},
allowedDevOrigins: ["localhost"],
async redirects() {
return [
{
Expand All @@ -19,10 +20,10 @@ const config = {
];
},

images: {
// Use Cloudflare Image Resizing instead of bundling image optimization
unoptimized: true,
},
images: {
// Use Cloudflare Image Resizing instead of bundling image optimization
unoptimized: true,
},
};

export default withMDX(config);
Expand Down