legalgonews/legalgo-BE-go
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
legalgo-BE-go/openapi.yml

798 lines
22 KiB
YAML
Raw Normal View History

docs: fix tags
2025-02-28 22:03:47 +08:00
openapi: 3.0.0
fix: path url and add docs
2025-02-24 20:27:07 +08:00
info:
title: Staff and User API
version: 1.0.0
description: API for handling staff and user login, registration, and subscription plan creation.
paths:
feat: category routes
2025-03-01 21:20:51 +08:00
/staff/profile:
get:
summary: "get staff profile"
tags:
- Staff
responses:
"200":
description: Success get profile
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
email:
type: string
fix: change username to name and add profile pic to staff
2025-03-03 10:39:01 +08:00
name:
type: string
profile_picture:
feat: category routes
2025-03-01 21:20:51 +08:00
type: string
"400":
description: Bad request
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
docs: fix path
2025-02-24 20:30:10 +08:00
/staff/login:
fix: path url and add docs
2025-02-24 20:27:07 +08:00
post:
summary: Login for staff
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
tags:
- Staff
fix: path url and add docs
2025-02-24 20:27:07 +08:00
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
password:
type: string
required:
- email
- password
responses:
"200":
description: Successful login
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
token:
type: string
description: JWT token for staff authentication
fix: path url and add docs
2025-02-24 20:27:07 +08:00
"400":
description: Bad request
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
fix: path url and add docs
2025-02-24 20:27:07 +08:00
docs: fix path
2025-02-24 20:30:10 +08:00
/staff/register:
fix: path url and add docs
2025-02-24 20:27:07 +08:00
post:
summary: Register a new staff member
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
tags:
- Staff
fix: path url and add docs
2025-02-24 20:27:07 +08:00
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
password:
type: string
fix: change username to name and add profile pic to staff
2025-03-03 10:39:01 +08:00
name:
type: string
profile_picture:
fix: docs and required field
2025-02-27 10:27:57 +08:00
type: string
fix: path url and add docs
2025-02-24 20:27:07 +08:00
required:
- email
- password
fix: change username to name and add profile pic to staff
2025-03-03 10:39:01 +08:00
- name
fix: path url and add docs
2025-02-24 20:27:07 +08:00
responses:
"201":
description: Staff member created
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
token:
type: string
description: JWT token for staff authentication
fix: path url and add docs
2025-02-24 20:27:07 +08:00
"400":
description: Bad request
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
fix: path url and add docs
2025-02-24 20:27:07 +08:00
"409":
description: Conflict (email already registered)
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
content:
application/json:
schema:
type: object
properties:
error:
type: object
feat: get user/staff profile
2025-02-27 18:59:58 +08:00
properties:
code:
type: string
message:
type: string
fix: get profile user/staff using token rather than id
2025-02-28 12:18:47 +08:00
/user/profile:
feat: get user/staff profile
2025-02-27 18:59:58 +08:00
get:
summary: "get staff profile"
tags:
docs: fix tags
2025-02-28 22:03:47 +08:00
- User
feat: get user/staff profile
2025-02-27 18:59:58 +08:00
responses:
"200":
description: Success get profile
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
email:
type: string
subscribe_plan_code:
type: string
subscribe_plan_name:
type: string
subscribe_status:
type: string
"400":
description: Bad request
content:
application/json:
schema:
type: object
properties:
error:
type: object
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
properties:
code:
type: string
message:
type: string
fix: path url and add docs
2025-02-24 20:27:07 +08:00
docs: fix path
2025-02-24 20:30:10 +08:00
/user/login:
fix: path url and add docs
2025-02-24 20:27:07 +08:00
post:
summary: Login for user
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
tags:
- User
fix: path url and add docs
2025-02-24 20:27:07 +08:00
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
password:
type: string
required:
- email
- password
responses:
"200":
description: Successful login
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
token:
type: string
description: JWT token for user authentication
fix: path url and add docs
2025-02-24 20:27:07 +08:00
"400":
description: Bad request
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
fix: path url and add docs
2025-02-24 20:27:07 +08:00
docs: fix path
2025-02-24 20:30:10 +08:00
/user/register:
fix: path url and add docs
2025-02-24 20:27:07 +08:00
post:
summary: Register a new user
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
tags:
- User
fix: path url and add docs
2025-02-24 20:27:07 +08:00
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
password:
type: string
subscribe_plan_id:
type: string
phone:
type: string
format: phone
required:
- email
- password
responses:
"201":
description: User created
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
token:
type: string
description: JWT token for user authentication
fix: path url and add docs
2025-02-24 20:27:07 +08:00
"400":
description: Bad request
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
fix: path url and add docs
2025-02-24 20:27:07 +08:00
"409":
description: Conflict (email already registered)
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
fix: path url and add docs
2025-02-24 20:27:07 +08:00
/subscribe-plan/create:
post:
summary: Create a new subscription plan
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
tags:
- Subscribe Plan
fix: path url and add docs
2025-02-24 20:27:07 +08:00
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
name:
type: string
fix: path url and add docs
2025-02-24 20:27:07 +08:00
code:
type: string
required:
- code
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
- name
fix: path url and add docs
2025-02-24 20:27:07 +08:00
responses:
"201":
description: Subscription plan created
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
message:
type: string
example: "Subscription plan created successfully."
fix: path url and add docs
2025-02-24 20:27:07 +08:00
"400":
description: Bad request
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
fix: path url and add docs
2025-02-24 20:27:07 +08:00
"409":
description: Conflict (plan code already exists)
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
fix: path url and add docs
2025-02-24 20:27:07 +08:00
fix: change path get all subscribe plan
2025-02-25 14:23:59 +08:00
/subscribe-plan:
docs: fix path
2025-02-24 20:32:08 +08:00
get:
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
summary: Get all subscription plans
tags:
- Subscribe Plan
fix: path url and add docs
2025-02-24 20:27:07 +08:00
responses:
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
"200":
description: Successfully retrieved all subscription plans
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
code:
type: string
name:
type: string
fix: path url and add docs
2025-02-24 20:27:07 +08:00
"400":
description: Bad request
fix: improvement response api and docs
2025-02-25 11:07:17 +08:00
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
feat: tag routes
2025-03-01 20:00:54 +08:00
/tag:
get:
summary: Get all tags
tags:
- Tags
responses:
"200":
description: Successfully retrieved all tags
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
code:
type: string
name:
type: string
"400":
description: Bad request
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
/tag/create:
post:
summary: Create a new tag
tags:
- Tags
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
code:
type: string
required:
- code
- name
responses:
"201":
description: Tag created
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
message:
type: string
example: "tag created successfully."
"400":
description: Bad request
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
"409":
description: Conflict (tag code already exists)
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
feat: category routes
2025-03-01 21:20:51 +08:00
/category:
get:
summary: Get all categories
tags:
- Category
responses:
"200":
description: Successfully retrieved all categories
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
code:
type: string
name:
type: string
"400":
description: Bad request
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
/category/create:
post:
summary: Create a new category
tags:
feat: news router
2025-03-02 04:36:17 +08:00
- Category
feat: category routes
2025-03-01 21:20:51 +08:00
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
code:
type: string
required:
- code
- name
responses:
"201":
description: Category created
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
message:
type: string
example: "category created successfully."
"400":
description: Bad request
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
"409":
description: Conflict (category code already exists)
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
feat: news router
2025-03-02 04:36:17 +08:00
/news/create:
post:
summary: Create a new news article
tags:
- News
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
content:
type: string
featured_image:
type: string
format: uri
tags:
type: array
items:
type: string
categories:
type: array
items:
type: string
is_premium:
type: boolean
live_at:
type: string
format: date-time
required:
- title
- content
- featured_image
- tags
- categories
- is_premium
- live_at
responses:
"201":
description: News article created
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
message:
type: string
example: "news created successfully."
"400":
description: Bad request
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
"409":
description: Conflict (e.g., duplicate title or invalid tag/category)
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
/news:
get:
summary: Get all news articles
tags:
- News
responses:
"200":
description: Successfully retrieved all news articles
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
content:
type: string
categories:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
code:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
tags:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
code:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
is_premium:
type: boolean
slug:
type: string
featured_image:
type: string
format: uri
author_id:
type: string
live_at:
type: string
format: date-time
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
"400":
description: Bad request
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
Reference in New Issue Copy Permalink