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

9775 appointments openapi #19037

Merged
merged 8 commits into from
Oct 23, 2024
Merged

9775 appointments openapi #19037

merged 8 commits into from
Oct 23, 2024

Conversation

kpethtel
Copy link
Contributor

Summary

Adds openapi schema testing for appointments and makes necessary adjustments to the schema to make it match reality.

Related issue(s)

department-of-veterans-affairs/va-mobile-app#9775

Testing done

This is all specs and docs. No testing needed.

Screenshots

Note: Optional

What areas of the site does it impact?

Specs and docs.

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 (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

Requested Feedback

@va-vfs-bot va-vfs-bot temporarily deployed to 9775-appointments-openapi/main/main October 23, 2024 16:36 Inactive
@@ -44,8 +44,5 @@ data:
locationId: '938'
meta:
errors: [{source: "VA Service"}]
checkinWindow:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of these checkin window references are deprecated.

@va-vfs-bot va-vfs-bot temporarily deployed to 9775-appointments-openapi/main/main October 23, 2024 17:12 Inactive
upcomingAppointmentsCount:
type: number
description: The number of BOOKED, non-pending appointments in the next upcomingDaysLimit number of days.
upcomingDaysLimit:
type: number
description: The number of days into the future used for calculating upcomingAppointmentsCount. The current value is 7.
pagination:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should extract pagination into a separate file because it's duplicated across several locations, but I didn't want to bloat this PR.

@va-vfs-bot va-vfs-bot temporarily deployed to 9775-appointments-openapi/main/main October 23, 2024 17:30 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to 9775-appointments-openapi/main/main October 23, 2024 17:49 Inactive
@@ -41,11 +41,6 @@ data:
patient_email: null
best_time_to_call: null
friendly_location_name: null
locationId: '938'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Location id is not in our serializer. I think this may have been added when we were working on appointment scheduling, but it doesn't seem to apply to the index.

@@ -0,0 +1,30 @@
type: object
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was previously missed.

schema:
$ref: ./schemas/Appointments.yml
description: OK
'207':
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was a missed case in our docs.

Copy link
Contributor

@aherzberg aherzberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kpethtel kpethtel merged commit b72caa8 into master Oct 23, 2024
38 checks passed
@kpethtel kpethtel deleted the 9775-appointments-openapi branch October 23, 2024 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants