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
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