Update CM v1.0 docs with API documentation

[rnair-tw]

Total of endpoints per HTTP Method

get => 52 post => 16 put => 22 patch => 1 delete => 11

List of Endpoints per HTTP Method

DELETE =>

'/cases/:caseId',
'/cases/:caseId/case-notes/:caseNoteId',
'/cases/:caseId/case-tags/:caseTagId',
'/cases/:caseId/inmates/:caseInmateId',
'/cases/:caseId/cases-officers/:caseOfficerId',
'/cases/:caseId/officers-allegations/:officerAllegationId',
'/cases/:caseId/attachments',
'/cases/:caseId/civilians/:civilianId',
'/tags/:id',
'/letter-types/:typeId',
'/signers/:id'

PUT =>

'/cases/:caseId',
'/cases/:caseId/restore',
'/cases/:caseId/status',
'/cases/:caseId/narrative',
'/cases/:caseId/case-notes/:caseNoteId',
'/cases/:caseId/inmates/:caseInmateId',
'/cases/:caseId/cases-officers/:caseOfficerId',
'/cases/:caseId/officers-allegations/:officerAllegationId',
'/cases/:caseId/letters/:letterId',
'/cases/:caseId/letters/:letterId/addresses',
'/cases/:caseId/letters/:letterId/content',
'/cases/:caseId/referral-letter/officer-history',
'/cases/:caseId/referral-letter/recommended-actions',
'/cases/:caseId/referral-letter/classifications',
'/cases/:caseId/referral-letter/addresses',
'/cases/:caseId/referral-letter/content',
'/cases/:caseId/referral-letter/approve-letter',
'/cases/:caseId/civilians/:civilianId',
'/tags/:id',
'/notifications/mark-as-read/:notificationId',
'/letter-types/:typeId',
'/signers/:id'

POST =>

'/cases',
'/cases/:caseId/case-notes',
'/cases/:caseId/case-tags',
'/cases/:caseId/inmates',
'/cases/:caseId/cases-officers',
'/cases/:caseId/cases-officers/:caseOfficerId/officers-allegations',
'/cases/:caseId/attachments',
'/cases/:caseId/letters',
'/cases/:caseId/civilians',
'/audit',
'/letter-types',
'/signers',
'/signatures',
'/logs',
'/example-letter-preview',
'/search-index'

PATCH =>

'/tags/:id'

GET =>

'/configs',
'/person-types',
'/public-data',
'/visualizations',
'/export/job/:jobId',
'/export/schedule/:operation',
'/cases',
'/cases/archived-cases',
'/cases/search',
'/cases/:caseId',
'/cases/:caseId/minimum-case-details',
'/cases/:caseId/case-history',
'/cases/:caseId/case-notes',
'/cases/:caseId/case-tags',
'/cases/:caseId/attachmentUrls',
'/cases/:caseId/letters/:letterId/pdf',
'/cases/:caseId/letters/:letterId/preview',
'/cases/:caseId/referral-letter',
'/cases/:caseId/referral-letter/preview',
'/cases/:caseId/referral-letter/edit-status',
'/cases/:caseId/referral-letter/final-pdf-download-url',
'/cases/:caseId/referral-letter/get-pdf',
'/officers/search',
'/inmates/search',
'/allegations/search',
'/allegations',
'/case-note-actions',
'/classifications',
'/tags',
'/intake-sources',
'/gender-identities',
'/how-did-you-hear-about-us-sources',
'/race-ethnicities',
'/civilian-titles',
'/data',
'/districts',
'/recommended-actions',
'/officer-history-options',
'/users',
'/messageStream',
'/notifications/:user',
'/notifications/:caseNoteId/:notificationId',
'/facilities',
'/letter-types',
'/signers',
'/signers/:id/signature',
'/case-statuses',
'/complaint-types',
'/rule-chapters',
'/directives',
'/priority-levels',
'/priority-reasons'

---

Which of these endpoints should we prioritize when creating a swagger documentation for the Complaint Manager API?

In scope

• [ ] Create a list with some endpoints that can be prioritized
• [ ] Check how much Github Copilot can help us with the documentation

[rnair-tw]

this card was a result of the API audit, and potentially should be put into CM v1.0 wiki

[rnair-tw]

make this into an action card

[heliofreitastw]

This wiki document has been created with the info in this card.

[andrew-rist-tw]

Picking this up. I plan to write a script that maps pact json to swagger. Will sync up with Helio when he gets back