Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Api 26837/shared schema updates for appeals #12961

Merged
merged 0 commits into from
Jun 13, 2023

Conversation

caseywilliams
Copy link
Contributor

Summary

Two updates to help bring appeals APIs in line with Lighthouse standards:

  1. the non_blank_string schema has been renamed to nonBlankString. Initially we had renamed this in the opposite direction, because we were using underscores in the URLs and trying to be consistent with that. But now that we're complying with standards, I've renamed this back to its original name. I did this because although there's no specific nonBlankString guidance in the standards, they say that field names in general should be in camelCase (naming standard)
  2. Adds an en-US Content-Language header (headers standard)

There are more changes to come for this ticket, but I figured this was enough for one PR

Related issue(s)

Testing done

  • Updated existing specs and regenerated docs

What areas of the site does it impact?

  • Segmented appeals APIs (these are not yet in production)

Acceptance criteria

  • I fixed|updated|added unit tests and integration tests for each feature (if applicable).
  • No error nor warning in the console.
  • Events are being sent to the appropriate logging solution
  • Documentation has been updated (link to documentation)
  • No sensitive information (i.e. PII/credentials/internal URLs/etc.) is captured in logging, hardcoded, or specs
  • Feature/bug has a monitor built into Datadog or Grafana (if applicable)
  • If app impacted requires authentication, did you login to a local build and verify all authenticated routes work as expected
  • I added a screenshot of the developed feature

@caseywilliams caseywilliams added Lighthouse lighthouse appeals Lighthouse API appeals banana-peels Lighthouse Banana Peels Team labels Jun 12, 2023
@caseywilliams caseywilliams requested review from a team as code owners June 12, 2023 16:14
@va-vfs-bot va-vfs-bot temporarily deployed to API-26837/shared-schema-updates-for-appeals/main/main June 12, 2023 16:17 Inactive
@mathisto
Copy link
Contributor

FWIW, I agree with your call on the field formatting and have been taking the same posture.

@va-vsp-bot va-vsp-bot requested a deployment to API-26837/shared-schema-updates-for-appeals/main/main June 12, 2023 22:09 In progress
@va-vsp-bot va-vsp-bot requested a deployment to API-26837/shared-schema-updates-for-appeals/main/main June 12, 2023 23:38 In progress
@caseywilliams caseywilliams force-pushed the API-26837/shared-schema-updates-for-appeals branch from 8a37f0d to d87806e Compare June 12, 2023 23:39
@va-vsp-bot va-vsp-bot requested a deployment to API-26837/shared-schema-updates-for-appeals/main/main June 12, 2023 23:39 In progress
@va-vfs-bot va-vfs-bot temporarily deployed to API-26837/shared-schema-updates-for-appeals/main/main June 12, 2023 23:47 Inactive
@caseywilliams caseywilliams merged commit e67f8ec into master Jun 13, 2023
@caseywilliams caseywilliams deleted the API-26837/shared-schema-updates-for-appeals branch June 13, 2023 15:49
ryan-mcneil pushed a commit that referenced this pull request Dec 11, 2023
* API-26837 Rename non_blank_string to nonBlankString in appeals

* API-26837 Add Content-Language header to appeals

This is suggested in Lighthouse standards
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
appeals Lighthouse API appeals banana-peels Lighthouse Banana Peels Team Lighthouse lighthouse
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants