bcgov / bcgov/entity

Add new API to the API Gateway

Open
#4,450 1 comment 0 reactions 0 assignees View on GitHub
apigw Epic
Dominant language
JavaScript
Stars
23
Forks
62
Avg merge
24m
Merged PRs (30d)
1

Description

BACKGROUND An API needs to be added to the Registries API Gateway
GIVEN The OpenApi Spec for the API is provided.
AND the test and prod service endpoints and credentials (if applicable) 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 a gateway API proxy needs to be created, deployed, and tested.
THEN a Postman example collection for publishing needs to be created.
THEN the gateway web site needs to be updated to add content for the new 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.