bcgov / bcgov/connect

Standardize and Publish the API Agreement document

Open
#47 0 comments 0 reactions 0 assignees View on GitHub
connect
Dominant language
No language data
Stars
0
Forks
4
Avg merge
1m
Merged PRs (30d)
2

Description

**Description**

Review and finalize the API Agreement to establish a standardized version that can be used across all products on the Connect platform.

**Scope**

- Identify the location of the latest copy of the API Agreement document
- Review the latest copy and revewers' comments.
- Address and resolve outstanding review comments.
- Determine whether product-specific versions or customizations exist and identify any content that should be generalized or separated into product-specific guidance.
- Standardize the document so it is applicable across all products.
- Select the appropriate document format and repository location.
- Publish the approved document as the single source of truth.
- Update documentation guidance so product teams can reference the published document instead of maintaining separate copies.
-
Acceptance Criteria:

- [ ] All review comments have been addressed.
- [ ] The document is standardized for use across products on the Connect platform.
- [ ] Product-specific content has been removed or clearly identified as product-specific guidance.
- [ ] The document has been reviewed and approved by interested parties.
- [ ] The final version is published in the agreed shared repository.
- [ ] Product teams are aware of the published document location.

**Timeline**: The document is needed before the Entities team begins onboarding API users later this summer.
**Target completion**: End of August.

Latest copy of the document (provided by Trish): [BC Registries and Digital Services - API Agreement (LSB Draft June 23 2025)](https://bcgov.sharepoint.com/:w:/r/teams/07509-Contracts/_layouts/15/Doc.aspx?sourcedoc=%7BD7AA42B0-F91E-4F52-A48D-60E5AA49CF3F%7D&file=BC%20Registries%20and%20Digital%20Services%20-%20API%20Agreement%20(LSB%20Draft%20June%2023%202025).docx&action=default&mobileredirect=true&isSPOFile=1&CID=8C6664B7-C196-47F1-AD29-F460E32D512F&wdLOR=cAB3886D3-C55E-4270-A806-1B2BCA3D80FF)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the linked SharePoint draft and locating any newer copies, reviewer comments, and product-specific versions. Confirm where the approved shared document and updated documentation guidance should live. Done means review comments are resolved, the agreement is standardized and approved, and product teams have the published single-source location.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.