Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

sandilya91
Copy link
Contributor

@sandilya91 sandilya91 commented Jul 7, 2025

Fix Collections API documentation by removing incorrect payload attributes from request examples that should only appear in responses.

Changes Made

  • POST Create Collection: Removed organization_id, groups_count, and groups from request payload example
  • PUT Update Collection: Removed organization_id and groups_count from request payload example
  • Both endpoints: Added proper 200 response examples showing complete collection data
  • Request examples: Now only show fields that are actually accepted as input parameters

Collections POST create

Screenshot 2025-07-07 at 11 12 06

Collections PUT update

Screenshot 2025-07-07 at 11 13 08

Fix documentation to remove incorrect payload attributes from the PUT request

- Fix parameter documentation inconsistencies
Copy link

cloudflare-workers-and-pages bot commented Jul 7, 2025

Deploying accredible-api-documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 38ffe42
Status: ✅  Deploy successful!
Preview URL: https://c07f3314.accredible-api-documentation.pages.dev
Branch Preview URL: https://feature-dgr-2123-fix-collect.accredible-api-documentation.pages.dev

View logs

@sandilya91 sandilya91 merged commit 4f86f6f into develop Jul 7, 2025
1 check passed
@sandilya91 sandilya91 deleted the feature/dgr-2123/fix-collections-payload-structure branch July 7, 2025 10:33
sandilya91 added a commit that referenced this pull request Jul 7, 2025
…equest (#102)

* docs: update collections API payload structure

Fix documentation to remove incorrect payload attributes from the PUT request

- Fix parameter documentation inconsistencies

* Add response example to Collection PUT endpoint

* Update payload structure for Collection create endpoint
@sandilya91 sandilya91 mentioned this pull request Jul 7, 2025
sandilya91 added a commit that referenced this pull request Jul 7, 2025
…equest (#102) (#103)

* docs: update collections API payload structure

Fix documentation to remove incorrect payload attributes from the PUT request

- Fix parameter documentation inconsistencies

* Add response example to Collection PUT endpoint

* Update payload structure for Collection create endpoint
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.

3 participants