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

add dollar sign to acceptable router paths #1055

Merged
merged 1 commit into from
Nov 18, 2021
Merged

add dollar sign to acceptable router paths #1055

merged 1 commit into from
Nov 18, 2021

Conversation

sam-hoffman
Copy link
Contributor

Describe the PR
Add $ to valid router paths for compatibility with HL7 FHIR standard.

The FHIR standard uses $ to prefix operations against compliant endpoints. Section 3.2.0.1 of the FHIR specification gives a definition and an example. Allowing $ as a modifier would enable teams working in Go to output Swagger specifications for APIs that interact with FHIR endpoints and further the goal of greater healthcare data interoperability around the world.

More information about HL7 FHIR standard
HL7 is a multinational non-profit organization that defines interoperability and messaging standards for the healthcare industry. The following countries use an HL7 defined specification as the primary method for messaging between healthcare providers: United States, Canada, Mexico, Australia, New Zealand, India, Pakistan, United Kingdom, Finland, Sweden, Spain, Turkey and Switzerland.

Historically, HL7 has facilitated information exchange through the sharing of documents. With the creation of the FHIR standard, HL7 aims to bring healthcare data movement in line with modern internet practices by introducing a REST based approach to exchange only relevant information instead of whole documents.

Relation issue
This PR would resolve issue #1053

@codecov
Copy link

codecov bot commented Nov 18, 2021

Codecov Report

Merging #1055 (fcdafef) into master (8d7941e) will not change coverage.
The diff coverage is n/a.

❗ Current head fcdafef differs from pull request most recent head 7f02d2d. Consider uploading reports for the commit 7f02d2d to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1055   +/-   ##
=======================================
  Coverage   93.97%   93.97%           
=======================================
  Files           8        8           
  Lines        2090     2090           
=======================================
  Hits         1964     1964           
  Misses         66       66           
  Partials       60       60           
Impacted Files Coverage Δ
operation.go 95.88% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8d7941e...7f02d2d. Read the comment docs.

Copy link
Contributor

@ubogdan ubogdan left a comment

Choose a reason for hiding this comment

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

LGTM

@ubogdan ubogdan merged commit 69fd233 into swaggo:master Nov 18, 2021
@ubogdan
Copy link
Contributor

ubogdan commented Nov 18, 2021

@sam-hoffman Thanks for your contribution.

@sam-hoffman sam-hoffman deleted the add-dollar-sign branch November 20, 2021 00:31
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.

2 participants