department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
281 stars 198 forks source link

NOD | Clean up NOD create request body `example.json` in vets-json-schema #70357

Open anniebtran opened 10 months ago

anniebtran commented 10 months ago

Value Statement

As a Developer I want to be able to reference/use the NOD create request body example defined in vets-json-schema So that we have example data to use in tests that is accurate and consistent

Background Context

As discovered in the work to clean up the NOD v2 controller and tests, we found that the mock/example data being used in the original iteration of the request specs was actually using the structure of the response body instead of the request body (see Lighthouse docs for POST /notice_of_disagreements) and this comment for investigation notes. So the goal here is to clean that up and fix that example to have the proper structure. We can reference the v2 Lighthouse docs to make sure we have everything covered.

This should also hopefully clean up the Swagger docs for vets-api (switch to v1 instead of v0 in the https://dev-api.va.gov/v0/apidocs in the "explore" bar at the top of the page)

Out of scope

Tasks

Definition of Ready

Definition of Done

saderagsdale commented 10 months ago

@anniebtran will estimate.

data-doge commented 9 months ago

Closing. Annie tested locally by hardcoding timezone. If our logs show this error reoccuring, we can re-open ticket.

data-doge commented 9 months ago

Woops, closed wrong ticket - ignore please.

saderagsdale commented 9 months ago

@data-doge I changed the status to "Ready for Pickup" and moved it to sprint 44.