Skip to content

DS-2756: Add GET Findings (Index & Show) API documentation#12

Open
jose-richard-91 wants to merge 6 commits intomainfrom
feat/DS-2756/api-get-findings-index-and-show
Open

DS-2756: Add GET Findings (Index & Show) API documentation#12
jose-richard-91 wants to merge 6 commits intomainfrom
feat/DS-2756/api-get-findings-index-and-show

Conversation

@jose-richard-91
Copy link

Summary

  • Documents the GET /api/external/findings index endpoint, including input parameters, pagination, response fields, and return codes
  • Documents the GET /api/external/findings/:id show endpoint, including URL parameters, response fields, and return codes
  • Organizes both endpoints under a new Tickets (FKA Issues) section in the public API docs

Test plan

  • Review rendered Slate docs to confirm both endpoints display correctly
  • Verify all parameters, response fields, and return codes match the actual Rails implementation
  • Confirm pagination documentation is accurate
  • Check that filter parameters (e.g., task_form_id, date range) are properly described

🤖 Generated with Claude Code

jose-richard-91 and others added 6 commits March 12, 2026 10:30
- Replace location_name with location + nestable_location fields
- Replace form_answer_id with form_answer_code
- Fix date format description (account-preference formatted string, not ISO 8601)
- Add max values for limit (200) and offset (10000) parameters

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
- Update JSON example: location_id/name/code, structured assignees/invitees,
  creator_id/email, assignees_concatenated, invitees_concatenated, form_answer_id
- Fix type field description: resolved name, not raw ID
- Fix offset max: 10000 → 2000 (matches MAX_OFFSET constant)
- Fix return codes: 403 → 401 Unauthorized
- Add asset_name, asset_identifier to response fields table

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
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