Dev: Create Documentation for the APIs

[ExperimentsInHonesty]

Overview

We need to create documentation for the APIs, so that LADOT manage them after the handoff.

Details

After reviewing the available documentation, Jason K. from LADOT asked for API documentation in 2025-10-14 meeting.

Action Items

• [x] Assign yourself to the development issue.
• [x] Move the development issue from the Prioritized Backlog to In Progress.
• [ ] Developer Tasks
  • [ ] Determine reasonable option for documenting Web API, including endpoint URL, Http verb, description of effect, request body format (if applicable), and authorization requirements.
  • [ ] Create documentation.
• [ ] Create a PR, if applicable.
• [ ] Create a new slide (or edit one if it already exists) in staging and add the before and after images
• [ ] Once the PR has been approved, use it to close this issue. If there is no PR is associated with this issue, close this issue after lead signoff.

Resources/Instructions

Staging and Release decks

• Staging Deck
  • Staging slide, 2692
• Release Deck
  • [2025-MM-DD Release deck, slide 2692]

[entrotech]

10/28/25: Investigating use of jsDoc and swagger, need to do some debugging on this approach and see if it can handle endpoints that require auth.