Northeastern-Electric-Racing / Northeastern-Electric-Racing/FinishLine
[Documentation] - Change organizationId to organization for service methods' documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 36
- Forks
- 9
- Avg merge
- 4d 21h
- Merged PRs (30d)
- 11
Description
Desired Changes
When refactoring the endpoints to use organizations instead of organizationId's, the documentation was never updated, this ticket is to update the documentation to reflect on the actual parameters passed into all the endpoints
Screenshots (as needed)
No response
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file, test, or entry point is named. Locate the service-method documentation, review each endpoint's documented parameters against the actual organization-based methods, and update every remaining organizationId reference; done means the documentation matches the parameters passed by all affected endpoints.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100