Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update OpenAPI specs for routes and correct docs for campaign endpoints #2179

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

dylancetin
Copy link

This commit fixes some routes' openapi specs by following lismonk.app/docs/

  1. GET Routes can't have a body. All params spesified in the body is moved up to query params and added some ENUMS to the type
  2. On the route /import/subscribers POST fixed content type to Multipart, added example params and fixed file type to string/binary

And also fixed API Docs for campaign routes' params

  1. Added no_body for some. These existed in OpenApi spec but was not present in the docs
  2. "GET /api/campaigns/analytics/{type}" fixed params description for "from" and "to"

Fixes #2077 and #2163

1. Added no_body for some. These existed in OpenApi spec but was not present in the docs
2. GET /api/campaigns/analytics/{type} fixed params description for "from" and "to"
This commit fixes some routes' openapi specs by following lismonk.app/docs/

1. GET Routes can't have a body. All params spesified in the body is moved up to query params
2. On the route /import/subscribers POST fixed content type to Multipart, added example params and fixed file type to string/binary
3. And added required: false to many
@dylancetin dylancetin changed the title fix: update OpenAPI specs for routes and campaign analytics endpoints fix: update OpenAPI specs for routes Nov 23, 2024
@dylancetin dylancetin changed the title fix: update OpenAPI specs for routes fix: update OpenAPI specs for routes and correct docs for campaign endpoints Nov 23, 2024
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.

Swagger Docs Error: GET /api/lists requires request body
1 participant