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.

cmd/web/docs/swagger.yaml

@@ -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: