[Spindown] Document manual processes

[kristen101606]

Description

Our VA enabling team has asked to document any manual processes (e.g. data analyses) used during the contract that may need to be used again.

Acceptance Criteria:

• [ ] Document processes in Github and/or Sharepoint
• [ ] Share with the enablement team and incorporate their feedback, if any

[a6marinos]

This is the 2122 BGS endpoint that can be leveraged from vets-api: https://dsva.slack.com/docs/T03FECE8V/F071ERTJU3C

[a6marinos]

ARGOCD Production: https://argocd.vfs.va.gov/applications/vets-api-prod?view=tree&resource=

[hdbaines]

Document any custom scripts as part of manual processes

[nihil2501]

🚨 Copy into our architecture intent meeting documentation. 🚨

Exercising BGS's POA request APIs

In order to witness API performance characteristics and examine domain data.

Layers

One can exercise these APIs by working at one of the following layers.

Lighthouse HTTP API

⚠️ Might be removed after the time of writing. ⚠️

Wraps BGS HTTP API.

Follow instructions for obtaining client credentials grant (CCG) for authenticating with the Benefits Claims API.

vets-api Rails console

⚠️ Might be removed after the time of writing. ⚠️

Implements Lighthouse HTTP API which wraps BGS HTTP API.

From ArgoCD

1. Requires SOCKS proxy configuration
2. Requires ArgoCD terminal access

From localhost

1. Requires SOCKS proxy configuration
2. Requires AWS console access
3. To identify the private IP DNS name of the vagov forward proxy
4. And set up ssh local port forwarding

BGS HTTP API

Wrapped by Lighthouse HTTP API.

1. Requires SOCKS proxy configuration
2. Requires AWS console access
3. To identify the private IP DNS name of the vagov forward proxy

APIs

Faceted, paginated, and sorted search of Power of Attorney requests

• VA developer documentation for the Lighthouse HTTP API
  • Only staging docs are available at the time of writing
  • Scroll to GET /power-of-attorney-requests
• Lighthouse HTTP API's Rails entry point and associated specs
  • PowerOfAttorneyRequestService::Search.perform(query)
• Cassettes that demonstrate the BGS HTTP API that is wrapped by the Lighthouse HTTP API

Create the decision for Power of Attorney requests

• VA developer documentation for the Lighthouse HTTP API
  • Only staging docs are available at the time of writing
  • Scroll to POST /power-of-attorney-requests/{id}/decision
• Lighthouse HTTP API's Rails entry point and associated specs
  • PowerOfAttorneyRequestService::Decide.perform(id, attributes)
• Cassettes that demonstrate the BGS HTTP API that is wrapped by the Lighthouse HTTP API