Skip to content

docs(DS-2756): Add GET /api/external/findings endpoint#6

Closed
jose-richard-91 wants to merge 5 commits intomainfrom
feat/DS-2756/api-get-tareas-creadas-index
Closed

docs(DS-2756): Add GET /api/external/findings endpoint#6
jose-richard-91 wants to merge 5 commits intomainfrom
feat/DS-2756/api-get-tareas-creadas-index

Conversation

@jose-richard-91
Copy link

Summary

  • Adds documentation for the new GET /api/external/findings external API endpoint
  • Documents all query parameters: start, end, status, limit, offset
  • Documents all response fields with types and descriptions
  • Includes curl and Ruby code examples with date range usage
  • Covers return codes including 422 for invalid/exceeded date range

Related

- 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]>
Base automatically changed from feat/DS-2757/tickets-api-get-findings-endpoint to master March 17, 2026 20:09
@jose-richard-91 jose-richard-91 changed the base branch from master to main March 17, 2026 20:20
@jose-richard-91 jose-richard-91 force-pushed the feat/DS-2756/api-get-tareas-creadas-index branch from c9b0236 to 5eb9a53 Compare March 17, 2026 23:39
- 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]>
@jose-richard-91 jose-richard-91 deleted the feat/DS-2756/api-get-tareas-creadas-index branch March 20, 2026 12:24
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