In Q2 2024 Survey Qualitative Feedback, VFS Full-stack engineer says: "What is missing? - vets-api is missing clear guidelines for how it should respond to successful and unsuccessful requests (2XX/4XX/5XX). (e.g. - If I'm developing an integration, when should my api client raise an error, and how should vets-api respond?)"
Issue Description
Platform Content team needs to ensure the website contains clear guidelines for how vets-api should respond to successful and unsuccessful requests.
Tasks
[ ] What work is necessary for this story to be completed?
Acceptance Criteria
[ ] What will be created or happen as a result of this story?
How to configure this issue
[ ] Attached to a Milestone (when will this be completed?)
[ ] Attached to an Epic (what body of work is this a part of?)
[ ] Labeled with Team (product support, analytics-insights, operations, service-design, Console-Services, tools-fe)
[ ] Labeled with Practice Area (backend, frontend, devops, design, research, product, ia, qa, analytics, contact center, research, accessibility, content)
[ ] Labeled with Type (bug, request, discovery, documentation, etc.)
Pain Point
Issue Description
Platform Content team needs to ensure the website contains clear guidelines for how vets-api should respond to successful and unsuccessful requests.
Tasks
Acceptance Criteria
[ ] What will be created or happen as a result of this story?
How to configure this issue
product support,analytics-insights,operations,service-design,Console-Services,tools-fe)backend,frontend,devops,design,research,product,ia,qa,analytics,contact center,research,accessibility,content)bug,request,discovery,documentation, etc.)