mazyar/tm_back
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Enhance Swagger Documentation for CMS API

Browse Source 
- Updated Swagger documentation to include new fields: CompanyName, Country, and Language, improving clarity and usability for API consumers.
- Added a new Type field with enumerations for Company and Organization, enhancing data categorization in the CMS API.
- Reflected changes in the definitions for CMS entities, ensuring accurate representation of the API structure and expected inputs/outputs.
- Improved examples in the documentation to provide better guidance for developers integrating with the CMS API.
This commit is contained in:
Nima Nakhostin
2025-11-09 10:21:41 +03:30
parent a363078d6f
commit 265ea4a7c6
3 changed files with 82 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/web/docs/docs.go
+31
View File
@@ -7771,6 +7771,14 @@ const docTemplate = `{
"language": {
"type": "string",
"example": "en"
},
"type": {
"allOf": [
{
"$ref": "#/definitions/cms.CMSType"
}
],
"example": "company"
}
}
},
@@ -7797,9 +7805,15 @@ const docTemplate = `{
"chart": {
"$ref": "#/definitions/cms.chartSection"
},
"company_name": {
"type": "string"
},
"contact": {
"$ref": "#/definitions/cms.contactSection"
},
"country": {
"type": "string"
},
"created_at": {
"type": "integer"
},
@@ -7818,11 +7832,28 @@ const docTemplate = `{
"key": {
"type": "string"
},
"language": {
"type": "string"
},
"type": {
"$ref": "#/definitions/cms.CMSType"
},
"updated_at": {
"type": "integer"
}
}
},
"cms.CMSType": {
"type": "string",
"enum": [
"company",
"organization"
],
"x-enum-varnames": [
"CMSTypeCompany",
"CMSTypeOrganization"
]
},
"cms.card": {
"type": "object",
"properties": {
cmd/web/docs/swagger.json
+31
View File
@@ -7763,6 +7763,14 @@
"language": {
"type": "string",
"example": "en"
},
"type": {
"allOf": [
{
"$ref": "#/definitions/cms.CMSType"
}
],
"example": "company"
}
}
},
@@ -7789,9 +7797,15 @@
"chart": {
"$ref": "#/definitions/cms.chartSection"
},
"company_name": {
"type": "string"
},
"contact": {
"$ref": "#/definitions/cms.contactSection"
},
"country": {
"type": "string"
},
"created_at": {
"type": "integer"
},
@@ -7810,11 +7824,28 @@
"key": {
"type": "string"
},
"language": {
"type": "string"
},
"type": {
"$ref": "#/definitions/cms.CMSType"
},
"updated_at": {
"type": "integer"
}
}
},
"cms.CMSType": {
"type": "string",
"enum": [
"company",
"organization"
],
"x-enum-varnames": [
"CMSTypeCompany",
"CMSTypeOrganization"
]
},
"cms.card": {
"type": "object",
"properties": {
cmd/web/docs/swagger.yaml
+20
View File
@@ -50,6 +50,10 @@ definitions:
language:
example: en
type: string
type:
allOf:
- $ref: '#/definitions/cms.CMSType'
example: company
type: object
cms.CMSListResponse:
properties:
@@ -66,8 +70,12 @@ definitions:
$ref: '#/definitions/cms.cardSection'
chart:
$ref: '#/definitions/cms.chartSection'
company_name:
type: string
contact:
$ref: '#/definitions/cms.contactSection'
country:
type: string
created_at:
type: integer
features:
@@ -80,9 +88,21 @@ definitions:
type: string
key:
type: string
language:
type: string
type:
$ref: '#/definitions/cms.CMSType'
updated_at:
type: integer
type: object
cms.CMSType:
enum:
- company
- organization
type: string
x-enum-varnames:
- CMSTypeCompany
- CMSTypeOrganization
cms.card:
properties:
description: