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

Update FHIR converter API docs #521

Merged
merged 10 commits into from
May 11, 2023
Merged

Conversation

emmastephenson
Copy link
Collaborator

@emmastephenson emmastephenson commented May 1, 2023

PULL REQUEST

Summary

Update the API docs for the FHIR converter.

Changes include:

  • renaming the FHIR-Converter-Installation-And-Usage-Guide.md to description.md so it appears in the /redoc endpoint
  • Updating some of the content on that page to be more in line with our other API doc descriptions
  • Adding documentation to the /convert-to-fhir endpoint
  • Adding descriptions to request params
  • Adding valid sample requests & responses

Related Issue

Fixes #487

Additional Information

Docs page before:

Screenshot 2023-05-03 at 2 21 41 PM
Screenshot 2023-05-03 at 2 21 51 PM

Docs page after:

Screenshot 2023-05-03 at 2 23 30 PM
Screenshot 2023-05-03 at 2 23 45 PM
Screenshot 2023-05-03 at 2 24 17 PM

@codecov
Copy link

codecov bot commented May 1, 2023

Codecov Report

Merging #521 (cd194c8) into main (08b7733) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #521   +/-   ##
=======================================
  Coverage   96.49%   96.49%           
=======================================
  Files          45       45           
  Lines        2479     2479           
=======================================
  Hits         2392     2392           
  Misses         87       87           
Flag Coverage Δ
unit-tests 96.49% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@emmastephenson emmastephenson changed the title Emma/487 fhir converter docs Update FHIR converter API docs May 3, 2023
@emmastephenson emmastephenson marked this pull request as ready for review May 3, 2023 21:37
@emmastephenson
Copy link
Collaborator Author

@robertmitchellv I realize this might have conflicts with #520 and #526 - I'm happy to resolve the merge conflicts once your PRs are in!

Copy link
Collaborator

@robertmitchellv robertmitchellv left a comment

Choose a reason for hiding this comment

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

@emmastephenson I don't think there will be too much conflict with #520 and #526 but thanks for agreeing to sort through the differences after those two land 🙇🏻

I like the changes to the docs with more instructions (especially highlighting Podman as an alternative for managing OCI containers and pods 🤩). I don't have any additional feedback--looks great to me!

@emmastephenson emmastephenson merged commit c149815 into main May 11, 2023
@emmastephenson emmastephenson deleted the emma/487-fhir-converter-docs branch May 11, 2023 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Review & update FHIR Converter container docs
2 participants