This is an API to retrieve the nutritional information of a given food item.
MIT License
1
stars
1
forks
source link
As a maintainer or client of the Nutrition Information API, I want a ping endpoint, so I can determine whether the Nutrition Information API is deployed #26
As a maintainer or client of the Nutrition Information API, I want a ping endpoint, so I can determine whether the Nutrition Information API is deployed
Acceptance Criteria
Given the Nutrition Information API is deployed, when a request is sent to https://{nutrition.information.api url}/v1/ping, then a response with a status 200 and empty body is returned
Test Plan
Manually test the acceptance criteria.
Add a component test to cover the acceptance criteria for the Ping feature.
Dev Work
ping.ts, create ./src/lambda/ping.ts
tsconfig.json, exclude the test folder
index.ts, remove ./index.ts
Documentation
There will be:
a swagger file to document the API.
a ping.feature file to document the Ping feature
It was considered to document how to manually deploy this ping endpoint, however given #6 we will not have to deploy manually soon. Therefore no documentation will be done at this point for deployment.
As a maintainer or client of the Nutrition Information API, I want a ping endpoint, so I can determine whether the Nutrition Information API is deployed
Acceptance Criteria
Test Plan
Dev Work
Documentation There will be:
It was considered to document how to manually deploy this ping endpoint, however given #6 we will not have to deploy manually soon. Therefore no documentation will be done at this point for deployment.
Definition of Ready