Vets API endpoint punch list

In order to direct an external service to a Vet-Api endpoint, service objects and associated controllers, routes, tests, and serializers need to be created.

Please go through the following list once the external service has been integrated:

Service Object

•  Service class
•  Config class & Faraday connection
•  Breakers initializer
•  Response class
•  settings.yml

Controller, Route & Serializer

•  Controller action
•  Route
•  Serializer

Frontend Signoff

• Agreement on API schema

Swagger Docs

•  app/swagger/request/*
•  app/swagger/schema/*
•  app/controllers/v0/apidocs_controller.rb

Betamocks

•  Config - vets-api/config/betamocks/services_config.yml
•  Create recording file
•  Update vets-api-mockdata/make_table.rb
• Update vets-api-mockdata/users.csv if applicable
•  Config - vets-api/config/settings.yml

Spec Coverage

•  Service object specs
•  Request specs (including swagger_spec.rb)
•  VCR cassettes
• Response schema

Deployment

•  Config set in vsp-infra-application-manifests/apps/vets-api/dev/values.yaml
• Config set in vsp-infra-application-manifests/apps/vets-api/staging/values.yaml
• Config set in vsp-infra-application-manifests/apps/vets-api/sandbox/values.yaml
•  Config set in vsp-infra-application-manifests/apps/vets-api/prod/values.yaml
•  Config set in devops/ansible/roles/review-instance-configure/templates/settings.local.yml

Source

• Stems from the Endpoint Punch List Presentation

• Source file for the presentation

Help and feedback

• Suggest content changes to this page.

• Submit new Platform Website content.

• Get help from the Platform Support Team in Slack.

• Submit a feature idea to the Platform.