bcgov / bcgov/entity

API Gateway add NR, NameX APIs

Open
#5,634 0 comments 0 reactions 1 assignee Claimed by @doug-lovett View on GitHub
apigw Epic
Dominant language
JavaScript
Stars
23
Forks
62
Avg merge
24m
Merged PRs (30d)
1

Description

BACKGROUND The Name Requests API and the NameX API need to be added to the Registries API Gateway
GIVEN The OpenApi Spec for the API is provided.
AND the environment service endpoints are provided

SCENARIO The spec linting generates warnings or errors
THEN The spec needs to be corrected.

SCENARIO The spec needs cleaning up before publishing
WHEN descriptions and examples are insufficient or missing
THEN the spec needs to be updated.
THEN gateway content (security) needs to be added to the spec.

SCENARIO The spec is ready for publishing
THEN the gateway mock service needs to be updated to add a names endpoint with the OAS example responses. The updated mock service needs to be deployed and tested.
THEN a gateway API proxy needs to be created, deployed, and tested.
THEN a Postman example collection for publishing needs to be created.
THEN the API developer site needs to be updated to add content for the new API.
THEN set up GCP logging for the API.
THEN set up GCP analytics statistics collection (metrics reporting) for the API.

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.