bcgov / bcgov/reserve-rec-api

Backcountry -> Look into endpoint documentation (swagger)

Open
#16 2 comments 0 reactions 0 assignees View on GitHub
Backcountry Reservations
Dominant language
JavaScript
Stars
2
Forks
7
Avg merge
15h 49m
Merged PRs (30d)
57

Description

#### Description:

Look into endpoint documentation (swagger) -> perhaps break into a new ticket (not super critical for operation of the system, but it is a documentation piece).
#### Acceptance Criteria:
[Note: Use 'Given/When/Then' format if it makes sense to. Otherwise, a simple checklist that can be tested.]

#### Development Checklist:

- [ ] ...
- [ ] ...
- [ ] ...

#### Dependencies

- Blocked by
- Blocking

**Relevant documentation as reference**

**Definition of Ready**

- [ ] Acceptance criteria are included
- [ ] Wireframes are included (if applicable)
- [ ] Design / Solution is accepted by Product Owner (if applicable)
- [ ] Dependencies are identified (technical, business, regulatory/policy)
- [ ] Story has been estimated (under 13 pts)

**Definition of Done**
- In progress:
- [ ] Acceptance criteria are tested (Functionality meets the acceptance criteria defined in the ticket)
- [ ] UI meets accessibility requirements
- [ ] Unit tests are written
- [ ] Work is traceable in GitHub
- [ ] PR linked to ticket number
- [ ] If needed/required - Dev adds flag/label to highlight any migration steps necessary prior to PROD deployment
- Code review:
- [ ] Code is peer reviewed and has passed CI/CD tests
- QA:
- [ ] Acceptance criteria are tested (Functionality meets the acceptance criteria defined in the ticket)
- [ ] Code is potentially shippable to the production environment
- [ ] Functional features have been tested and passed by QA
- [ ] UI components tested by designer
- [ ] Code is deployed to PROD when moved to 'done' column (unless requested otherwise by PO)
- PO Review:
- [ ] Acceptance criteria are tested (Functionality meets the acceptance criteria defined in the ticket)
- [ ] Reviewed and approved by Product Owner

#### Notes:
-
-

Contributor guide

No contributing guide indexed for this repository

Research direction

No file, test, entry point, or concrete acceptance criterion is identified. Start by locating the repository's endpoint handlers and any existing Swagger/OpenAPI configuration, then define the documentation scope and a testable checklist. Done means the agreed endpoints are documented and the work is traceable to this issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, nodejs, openapi
Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.