Skip to content

feat: update get insights and purge API schemas and error responses #326

Merged
siddu1819 merged 1 commit intomainfrom
fix/purge-api-errors-clean
Aug 20, 2025
Merged

feat: update get insights and purge API schemas and error responses #326
siddu1819 merged 1 commit intomainfrom
fix/purge-api-errors-clean

Conversation

@siddu1819
Copy link
Copy Markdown
Contributor

@siddu1819 siddu1819 commented Aug 20, 2025

  • Updated DELETE /v3/purge endpoint error responses to use new error schema
  • Added comprehensive error examples for 400, 401, 404, 422, and 500 status codes
  • Updated error response body structure with timestamp, version, txnid, and nested error object
  • Included only actual thrown errors

- Updated DELETE /v3/purge endpoint error responses to use new error schema
- Added comprehensive error examples for 400, 401, 404, 422, and 500 status codes
- Updated error response body structure with timestamp, version, txnid, and nested error object
- Included only actual thrown errors, removed logged-only errors
@github-actions
Copy link
Copy Markdown

Checklist to merge a PR 🚀

To merge this pull request, please take time to complete the checklist.

What action did you perform?

Review the corresponding checklist items for the action you performed and mark them done.

Edit an existing content (MDX) page

Checklist

  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • If a redirect is needed to the existing page, add a key, value pair in redirects.json

Edit an existing API reference page

Checklist


Add a new content (MDX) page

Checklist

  • Create a .mdx file with the path as its name in the content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • Created a folder with the same name, if any children were to be added to the page
  • Once all changes are done, update the menu items by using the Menu Items option
  • Add a key, and value pair in redirects.json if you wish to have a redirect to the new page

Add a new API reference page

Checklist

  • Create a .json file with the product path as its name
  • Create an api-reference.mdx file in the respective product folder inside content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Add API reference in JSON format (OpenAPI or Swagger) into created .json file.
  • Used the Content preview portal to view changes
  • Once all changes are done, update the menu items by using the Menu Items option

@siddu1819 siddu1819 changed the title feat: update purge API error responses with new schema structure feat: update get insights and purge API schemas and error responses Aug 20, 2025
@aotella aotella self-requested a review August 20, 2025 11:41
@siddu1819 siddu1819 merged commit 11faf6a into main Aug 20, 2025
1 check passed
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.

2 participants