bcgov / bcgov/orgbook-bc-api-docs
Add documentation around api payloads
- Dominant language
- JavaScript
- Stars
- 5
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
The payloads for some api endpoints (for example `/v4/topic/{id}/credential-set`) are fairly complicated and difficult to interpret for someone who is not familiar with the orgbook data model and how credentials are issued, received and processed.
Add some documentation to this site to explain:
- the core orgbook credentials (registration, business number, relationship)
- how credential history works
- how data is presented in payloads and how to look up the credential attribute values
- how to request active creds only, history, etc
- how to use id's from one endpoint as a filter for another endpoint (e.g. look up a company and then find credentials for that company)
Contributor guide
Research direction
Start with the documentation site and the example /v4/topic/{id}/credential-set endpoint. Trace how the listed credential types, history, payload attributes, active/history options, and cross-endpoint IDs are represented; it is done when these workflows are explained clearly for readers unfamiliar with the OrgBook data model.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100