bcgov / bcgov/entity

Update API Specifications for Group 2 Onboarding

Open
#30,495 2 comments 0 reactions 2 assignees Claimed by @meawong View on GitHub
Entities Team
Dominant language
JavaScript
Stars
23
Forks
62
Avg merge
24m
Merged PRs (30d)
1

Description

There have been recent discussions in Discourse raising concerns that our published API specifications may be outdated or inaccurate. Additionally, some recent feature changes might not yet be reflected in the current API documentation.

**Problem:**
• API specs used during onboarding may contain inaccuracies or missing details.
• This creates confusion for new API users and increases support overhead.
• Any recent feature updates or parameter changes may not be properly documented.

**Goal:**

To ensure API users receive accurate, complete, and up-to-date specifications during onboarding, reducing confusion and support requests.

**Tasks :**

- [ ] Review the current API specifications required for Group 2 onboarding. Focus on the features and filings that will be available for this particular group (the filings currently available in Production are the priority).
- [ ] Compare them against the live API behavior and recent feature updates.
- [ ] Identify and correct any inconsistencies, outdated information, or missing fields.
- [ ] Coordinate with the dev team to confirm recent or upcoming changes that might impact the specs.
- [ ] Review feedback from Discourse threads.
- [ ] Update the specs and publish a revised version.

Please add sub-tickets as needed.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.