bcgov/orgbook-bc-api-docs

Documentation for OrgBook BC API

orgbook-bc-api-docs's Issues

Enable searching on other identifiers beyond Legal Name, BC Registries ID and BN

What we would like is a process for being able to add identifiers from credentials other than those from BC Registries to the search index and autocomplete widget. Today, that would include the Cannibis permits and BuyBC licenses, but others are also possible. Define a generic mechanism/process to add new identifiers when needed, starting with the ones available at the time. Presumably, the registration of a credential type would include indicating what fields are searchable, and those would be added to the searching mechanism. The process does not have to be fully automated -- at least not until we are regularly adding new issuers.

When added, the main screen should be updated to list "Other identifiers", with a popup that includes a generated list of all combinations of other searchable identifiers, the source credential type and issuer.

Add project lifecycle badge

No Project Lifecycle Badge found in your readme!

Hello! I scanned your readme and could not find a project lifecycle badge. A project lifecycle badge will provide contributors to your project as well as other stakeholders (platform services, executive) insight into the lifecycle of your repository.

What is a Project Lifecycle Badge?

It is a simple image that neatly describes your project's stage in its lifecycle. More information can be found in the project lifecycle badges documentation.

What do I need to do?

I suggest you make a PR into your README.md and add a project lifecycle badge near the top where it is easy for your users to pick it up :). Once it is merged feel free to close this issue. I will not open up a new one :)

Add documentation around api payloads

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)

Rename repo

This repo should be renamed to properly express what it is. I suggest renaming to orgbook-bc-api-documentation as this is not technically an API and has specific guidance for OrgBook BC API rather than a more generic OrgBook (Aries VCR) implementation.

It's Been a While Since This Repository has Been Updated

This issue is a kind reminder that your repository has been inactive for 181 days. Some repositories are maintained in accordance with business requirements that infrequently change thus appearing inactive, and some repositories are inactive because they are unmaintained.

To help differentiate products that are unmaintained from products that do not require frequent maintenance, repomountie will open an issue whenever a repository has not been updated in 180 days.

• If this product is being actively maintained, please close this issue.
• If this repository isn't being actively maintained anymore, please archive this repository. Also, for bonus points, please add a dormant or retired life cycle badge.

Thank you for your help ensuring effective governance of our open-source ecosystem!

It's Been a While Since This Repository has Been Updated

This issue is a kind reminder that your repository has been inactive for 181 days. Some repositories are maintained in accordance with business requirements that infrequently change thus appearing inactive, and some repositories are inactive because they are unmaintained.

To help differentiate products that are unmaintained from products that do not require frequent maintenance, repomountie will open an issue whenever a repository has not been updated in 180 days.

• If this product is being actively maintained, please close this issue.
• If this repository isn't being actively maintained anymore, please archive this repository. Also, for bonus points, please add a dormant or retired life cycle badge.

Thank you for your help ensuring effective governance of our open-source ecosystem!

Bad Request response when try to paginate after page 10

I'm filtering by category and paginating to fetch the results, but when I try to paginate after page 10 I get Bad Request response from API, this error occurs for all categories.

Working request:
https://www.orgbook.gov.bc.ca/api/v2/search/credential/facets?category%253Aentity_type=XS&ordering=effective_date&page=10&category%3Aentity_type=XS

Failure request (Any number after 10 result in error):
https://www.orgbook.gov.bc.ca/api/v2/search/credential/facets?category%253Aentity_type=XS&ordering=effective_date&page=11&category%3Aentity_type=XS

Move repo to BC Gov

@amanji and @WadeBarnes -- can the two of you coordinate on getting this repo moved into BCGov organization? I'd like to enable updates to it by others. It's ready!

It's Been a While Since This Repository has Been Updated

This issue is a kind reminder that your repository has been inactive for 180 days. Some repositories are maintained in accordance with business requirements that infrequently change thus appearing inactive, and some repositories are inactive because they are unmaintained.

To help differentiate products that are unmaintained from products that do not require frequent maintenance, repomountie will open an issue whenever a repository has not been updated in 180 days.

• If this product is being actively maintained, please close this issue.
• If this repository isn't being actively maintained anymore, please archive this repository. Also, for bonus points, please add a dormant or retired life cycle badge.

Thank you for your help ensuring effective governance of our open-source ecosystem!

Add project lifecycle badge

No Project Lifecycle Badge found in your readme!

Hello! I scanned your readme and could not find a project lifecycle badge. A project lifecycle badge will provide contributors to your project as well as other stakeholders (platform services, executive) insight into the lifecycle of your repository.

What is a Project Lifecycle Badge?

It is a simple image that neatly describes your project's stage in its lifecycle. More information can be found in the project lifecycle badges documentation.

What do I need to do?

I suggest you make a PR into your README.md and add a project lifecycle badge near the top where it is easy for your users to pick it up :). Once it is merged feel free to close this issue. I will not open up a new one :)

Update API examples with v4 search/autocomplete

The examples reference the now deprecated v3 version of search and autocomplete. A newer/shinier v4 update is available