Skip to content

24998 - Replace API Gateway with Developer Site #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion web/site/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Code of Conduct - SBC API Gateway
# Code of Conduct - SBC Developer Site

## Our Pledge

Expand Down
8 changes: 4 additions & 4 deletions web/site/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- omit in toc -->
# Contributing to SBC API Gateway
# Contributing to SBC Developer Site

First off, thanks for taking the time to contribute! ❤️

Expand All @@ -25,7 +25,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
## Code of Conduct

This project and everyone participating in it is governed by the
[SBC API Gateway Code of Conduct](https://github.com/bcgov/sbc-apigw/tree/main/web/site/CODE_OF_CONDUCT.md).
[SBC Developer Site Code of Conduct](https://github.com/bcgov/sbc-apigw/tree/main/web/site/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior
to <>. Add contact?

Expand Down Expand Up @@ -104,7 +104,7 @@ Once it's filed:

### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for SBC API Gateway, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
This section guides you through submitting an enhancement suggestion for SBC Developer Site, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

<!-- omit in toc -->
#### Before Submitting an Enhancement
Expand All @@ -122,7 +122,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/bcgov/
- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
- **Explain why this enhancement would be useful** to most SBC API Gateway users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
- **Explain why this enhancement would be useful** to most SBC Developer Site users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

<!-- TODO
### Your First Code Contribution
Expand Down
9 changes: 7 additions & 2 deletions web/site/app/components/Sbc/Docs/SideNavigation.vue
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<script setup lang="ts">
const props = defineProps<{
navItems: AccordianNavItem[] | undefined
navItems: AccordianNavItem[] | undefined,
isMobile: boolean | undefined,
}>()

const getStartedNavItems = computed(() => {
Expand All @@ -13,7 +14,11 @@ const exceptgetStartedNavItems = computed(() => {

</script>
<template>
<aside class="mx-2 min-w-56 max-w-min border-r-2 border-bcGovColor-hairlinesOnWhite " data-testid="docs-side-navigation">
<aside
class="mx-2 min-w-56 max-w-min border-bcGovColor-hairlinesOnWhite"
:class="{ 'border-r-2': !isMobile }"
data-testid="docs-side-navigation"
>
<div class="flex items-center text-base font-semibold uppercase text-bcGovColor-midGray">
{{ $t('SbcNavigation.intro') }}
</div>
Expand Down
2 changes: 1 addition & 1 deletion web/site/app/components/Sbc/MobileNav.vue
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ const {
</template>
</UAccordion>
<UDivider class="my-4" />
<SbcDocsAccordianNavigation :nav-items="accordianNavItems" />
<SbcDocsSideNavigation :nav-items="accordianNavItems" :is-mobile="true" />
</UCard>
</UModal>
</template>
4 changes: 2 additions & 2 deletions web/site/app/tests/e2e/pages/home-page.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ test.describe('home page', () => {
const p = await page.textContent('p')
const logo = page.getByAltText('Government of British Columbia Logo')
expect(logo).toBeTruthy()
expect(h1).toBe('BC Registries API Gateway')
expect(p).toBe('Welcome to the BC Registries API Gateway! Access API information for all BC Registries services here.')
expect(h1).toBe('BC Registries Developer Site')
expect(p).toBe('Welcome to the BC Registries Developer Site! Access API information for all BC Registries services here.')
})
})
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Here is a 400 Bad Request response body example when submitting a payment API in

### How Security Works

On successful completion of an API access request you will be issued a gateway API key that is globally unique and tied to your security account. As part of the access request you specify which APIs you want to use. Gateway authentication requires that your API key is included with each request, and that the API key has permission to accesss the API that the request is for. More granular Registries authorization is managed by the security role(s) associated with your BC OnLine account Id, which is linked to both your security account and your API key.
On successful completion of an API access request you will be issued a gateway API key that is globally unique and tied to your security account. As part of the access request you specify which APIs you want to use. Gateway authentication requires that your API key is included with each request, and that the API key has permission to accesss the API that the request is for. More granular Registries authorization is managed by the security role(s) associated with your SBC Connect account Id, which is linked to both your security account and your API key.

As part of the access request you will receive instructions on maintaining your API key: how to request a new one and how to replace an existing one for an API gateway environment.

Expand Down Expand Up @@ -180,7 +180,7 @@ payment receipt information for your API transaction.

### Analytics Reports

ServiceBC Connect Account consumer API Gateway activity is tracked for up to 30 days in
ServiceBC Connect Account consumer Developer Site activity is tracked for up to 30 days in
the past. Daily and weekly reports are available in JSON or CSV formats. Basic
metrics available in these reports include:

Expand All @@ -199,7 +199,7 @@ into your own data visualization tools or analytics system.

### Message Logging

ServiceBC Connect Account consumer API Gateway message logging is available by account
ServiceBC Connect Account consumer Developer Site message logging is available by account
ID and Gateway API. A dedicated message log archive is created for an account ID
and API combination. It requires a Google Cloud Platform (GCP) account and
project configured with permission to view the account message log. Message log
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ description: 'Follow these steps to complete your API access requests.'

Follow these steps to complete your API access requests.

1. You will need a BC OnLine account. If you do not have one already, you can request one <a href="https://apps.bconline.gov.bc.ca/AccountSetup/index.jsp?mode=new" target="_blank">here</a>. Payment information is provided as part of your BC OnLine account set up. API service fee charges will be applied to your BC OnLine account.
2. Submit an API access request and setup your account <a href="https://www.bcregistry.ca/business/auth/setup-account" target="_blank">here</a>. As part of the access request, you need to provide your BC OnLine account Id and which APIs you want to use. **Link and further instructions to be provided.**
1. You will need a SBC Connect account. If you do not have one already, you can request one <a href="https://apps.bconline.gov.bc.ca/AccountSetup/index.jsp?mode=new" target="_blank">here</a>. Payment information is provided as part of your SBC Connect account set up. API service fee charges will be applied to your SBC Connect account.
2. Submit an API access request and setup your account <a href="https://www.bcregistry.ca/business/auth/setup-account" target="_blank">here</a>. As part of the access request, you need to provide your SBC Connect account Id and which APIs you want to use. **Link and further instructions to be provided.**
3. When you receive approval for your access request, legally sign your Terms of Use agreement.
4. After signing your access request agreement, you will receive an API key with TEST access and instructions on how to maintain it. You can then start using the BC Registries APIs. You will also receive information on how to request a PRODUCTION API key.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -230,5 +230,5 @@ be updated over time.
## Outstanding

- How to subscribe to analytics reports.
- How to publish analytics reports to invidual BC OnLine accounts.
- How to publish analytics reports to invidual SBC Connect accounts.
- What to charge for analytics reports. -->
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: 'Message Logging'
description: 'BC OnLine Account API Gateway message logging information.'
description: 'SBC Connect Account Developer Site message logging information.'
---

# Message Logging

---

Service BC Connect API message logging is configured by Account ID number and
the API. The combination of the API Gateway environment, account ID, and API name
the API. The combination of the Developer Site environment, account ID, and API name
is used to create a unique log name.

The Service BC Connect API Platform uses Google Cloud Platform (GCP) logging. With GCP logging,
Expand Down
2 changes: 1 addition & 1 deletion web/site/content/en-CA/products/1.get-started/6.about.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'About'
description: 'API Gateway About page. Useful information.'
description: 'Developer Site About page. Useful information.'
---

# About
Expand Down
2 changes: 1 addition & 1 deletion web/site/content/en-CA/products/rs/registry-search.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1563,7 +1563,7 @@ components:
securitySchemes:
api_key:
type: apiKey
description: API Gateway assigned API key for a consumer. Required for all requests.
description: Developer Site assigned API key for a consumer. Required for all requests.
name: x-apikey
in: header
jwt:
Expand Down
4 changes: 2 additions & 2 deletions web/site/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ The page head is automatically mapped based on the current markdown file structu

For example:
- `content/en-CA/products/get-started/account-setup.md` will return the page head as:
`Get Started - Account Setup - Service BC Connect API Gateway`.
`Get Started - Account Setup - Service BC Connect Developer Site`.
- `content/en-CA/products/br/overview.md` will return the page head as:
`BR - Overview - Service BC Connect API Gateway`.
`BR - Overview - Service BC Connect Developer Site`.

<!-- omit in toc -->
### Page Title and Description
Expand Down
2 changes: 1 addition & 1 deletion web/site/public/strr/platform.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,7 @@ components:
securitySchemes:
api_key:
type: apiKey
description: API Gateway assigned API key. Required for all requests.
description: Developer Site assigned API key. Required for all requests.
name: x-apikey
in: header
jwt:
Expand Down
Loading