Enhance Swagger Documentation for CMS API
- 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:
@@ -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": {
|
||||
|
||||
Reference in New Issue
Block a user