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 devops/ansible/deployment/config/vets-api/dev-settings.local.yml.j2
  • Config set in devops/ansible/deployment/config/vets-api/staging-settings.local.yml.j2
  •  Config set in devops/ansible/deployment/config/vets-api/prod-settings.local.yml.j2
  •  Config set in devops/ansible/roles/review-instance-configure/templates/settings.local.yml

Source