Skip to content

docs(swagger): add swagger models and update API annotations#3

Open
oismaelash wants to merge 1 commit intoEvolutionAPI:mainfrom
oismaelash:docs/swager-update
Open

docs(swagger): add swagger models and update API annotations#3
oismaelash wants to merge 1 commit intoEvolutionAPI:mainfrom
oismaelash:docs/swager-update

Conversation

@oismaelash
Copy link
Copy Markdown

@oismaelash oismaelash commented Mar 31, 2026

Add centralized swagger models in pkg/core/swagger_models.go to provide consistent API response structures. Update all handler Swagger annotations to reference these core models instead of generic gin.H responses. This improves API documentation clarity and ensures consistent response formats across all endpoints.

Additionally, refactor version initialization in main.go to use a function and add WebSocket endpoint documentation.

Description

Related Issue

Closes #(issue_number)

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvement

Testing

  • Manual testing completed
  • Functionality verified in development environment
  • No breaking changes introduced

Screenshots (if applicable)

responses 400 to 500:
image

all endpoint available on swagger:
image

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have tested my changes thoroughly
  • Any dependent changes have been merged and published

Additional Notes

Add centralized swagger models in pkg/core/swagger_models.go to provide consistent API response structures.
Update all handler Swagger annotations to reference these core models instead of generic gin.H responses.
This improves API documentation clarity and ensures consistent response formats across all endpoints.

Additionally, refactor version initialization in main.go to use a function and add WebSocket endpoint documentation.
Copy link
Copy Markdown

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @oismaelash, your pull request is larger than the review limit of 150000 diff characters

@oismaelash oismaelash marked this pull request as ready for review March 31, 2026 01:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant