From 657a472d4693671fd8feed249b00ce9e49bd7331 Mon Sep 17 00:00:00 2001 From: austincanada <162146803+austincanada@users.noreply.github.com> Date: Thu, 11 Apr 2024 13:35:38 -0400 Subject: [PATCH] BCDA-7971: Update curl commands with double quotes (#194) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This feature updates all curl command snippets that have single quotes to double quotes in order for them to run properly on Windows and UNIX based systems. ## 🎫 Ticket https://jira.cms.gov/browse/BCDA-7971 ## 🛠 Changes Updated the `_includes/` files that contained cURL snippets. ## ℹ️ Context for reviewers N/A ## ✅ Acceptance Validation Changes verified on local static site. ## 🔒 Security Implications - [ ] This PR adds a new software dependency or dependencies. - [ ] This PR modifies or invalidates one or more of our security controls. - [ ] This PR stores or transmits data that was not stored or transmitted before. - [ ] This PR requires additional review of its security implications for other reasons. If any security implications apply, add Jason Ashbaugh (GitHub username: StewGoin) as a reviewer and do not merge this PR without his approval. Co-authored-by: Austin Canada --- _includes/build/access_token.html | 4 ++-- _includes/build/attribution_status.html | 2 +- _includes/build/bcda_v2.html | 4 ++-- _includes/build/jobs_history.html | 2 +- _includes/build/requesting_data_all_three.html | 10 +++++----- _includes/build/requesting_data_runouts.html | 6 +++--- .../build/requesting_filtered_data_since_Group.html | 2 +- .../build/requesting_filtered_data_since_Patient.html | 2 +- _includes/guide/bcda_v2.html | 4 ++-- _includes/guide/try_the_api.html | 8 ++++---- _includes/partial/faq.html | 2 +- 11 files changed, 23 insertions(+), 23 deletions(-) diff --git a/_includes/build/access_token.html b/_includes/build/access_token.html index d6f086a..93a0ef3 100644 --- a/_includes/build/access_token.html +++ b/_includes/build/access_token.html @@ -35,7 +35,7 @@

cURL Option 1: This cURL command requires separate base-64 encryption. We have concatenated the base64 encoding of the ‘Client ID : Secret’ as the argument to the -H flag. Please note that the URL in the Production environment will be different.

-
curl -d '' -X POST 'https://sandbox.bcda.cms.gov/auth/token' \
+
curl -d "" -X POST "https://sandbox.bcda.cms.gov/auth/token" \
 	-H "accept: application/json" \
 	-H "authorization: Basic MjQ2MmM5NmItNjQyNy00ZWZiLWFlZDctMTE4ZTIwYzJlOTk3OjhlODdmMGViYzUwZDEwZjFiYzk3MzQzMjlhOTkwMDE3OWI4NGNjZDM5ZTRkMDkyMGI5MDVjYzM1OWNmNmU5NGE2ZTc2MGJiZTNhMDg5MGM3"
@@ -43,7 +43,7 @@

cURL Option 2: This cURL command encrypts your credentials with base-64 encryption

-
curl -d '' -X POST 'https://sandbox.bcda.cms.gov/auth/token' \
+
curl -d "" -X POST "https://sandbox.bcda.cms.gov/auth/token" \
 	--user 2462c96b-6427-4efb-aed7-118e20c2e997:8e87f0ebc50d10f1bc9734329a9900179b84ccd39e4d0920b905cc359cf6e94a6e760bbe3a0890c7 \
 	-H "accept: application/json"

diff --git a/_includes/build/attribution_status.html b/_includes/build/attribution_status.html index ecd7990..057741e 100644 --- a/_includes/build/attribution_status.html +++ b/_includes/build/attribution_status.html @@ -14,7 +14,7 @@

Request Headers

Accept: application/json

cURL Command to retrieve the attribution status

-
curl -X GET 'https://api.bcda.cms.gov/api/v2/attribution_status' \
+
curl -X GET "https://api.bcda.cms.gov/api/v2/attribution_status" \
     -H "accept: application/json" \
     -H "Authorization: Bearer {access_token}"
diff --git a/_includes/build/bcda_v2.html b/_includes/build/bcda_v2.html index 0bdfd59..2fb3709 100644 --- a/_includes/build/bcda_v2.html +++ b/_includes/build/bcda_v2.html @@ -20,14 +20,14 @@

-
curl -X GET 'https://api.bcda.cms.gov/api/v2/Group/all/$export' \
+                    
curl -X GET "https://api.bcda.cms.gov/api/v2/Group/all/$export" \
 -H "accept: application/fhir+json" \
 -H "Prefer: respond-async" \
 -H "Authorization: Bearer {access_token}" \
 -v
-
curl -X GET 'https://api.bcda.cms.gov/api/v1/Group/all/$export' \
+                    
curl -X GET "https://api.bcda.cms.gov/api/v1/Group/all/$export" \
 -H "accept: application/fhir+json" \
 -H "Prefer: respond-async" \
 -H "Authorization: Bearer {access_token}" \
diff --git a/_includes/build/jobs_history.html b/_includes/build/jobs_history.html
index f6566eb..01707b7 100644
--- a/_includes/build/jobs_history.html
+++ b/_includes/build/jobs_history.html
@@ -15,7 +15,7 @@ 

Request Headers

Prefer: respond-async

cURL Command to check the job status

-
curl -X GET 'https://api.bcda.cms.gov/api/v2/jobs' \
+
curl -X GET "https://api.bcda.cms.gov/api/v2/jobs" \
     -H "accept: application/fhir+json" \
     -H "Prefer: respond-async" \
     -H "Authorization: Bearer {access_token}"
diff --git a/_includes/build/requesting_data_all_three.html b/_includes/build/requesting_data_all_three.html index 3110a36..4134ed4 100644 --- a/_includes/build/requesting_data_all_three.html +++ b/_includes/build/requesting_data_all_three.html @@ -29,19 +29,19 @@

Request Headers

cURL Commands to start a job

  1. -
    curl -X GET 'https://api.bcda.cms.gov/api/v2/Group/all/$export' \
    +		
    curl -X GET "https://api.bcda.cms.gov/api/v2/Group/all/$export" \
     	-H "accept: application/fhir+json" \
     	-H "Prefer: respond-async" \
     	-H "Authorization: Bearer {access_token}"
  2. -
    curl -X GET 'https://api.bcda.cms.gov/api/v2/Group/all/$export?_type=ExplanationOfBenefit,Patient' \
    +		
    curl -X GET "https://api.bcda.cms.gov/api/v2/Group/all/$export?_type=ExplanationOfBenefit,Patient" \
     	-H "accept: application/fhir+json" \
     	-H "Prefer: respond-async" \
     	-H "Authorization: Bearer {access_token}"
  3. -
    curl -X GET 'https://api.bcda.cms.gov/api/v2/Group/all/$export?_type=Patient' \
    +		
    curl -X GET "https://api.bcda.cms.gov/api/v2/Group/all/$export?_type=Patient" \
     	-H "accept: application/fhir+json" \
     	-H "Prefer: respond-async" \
     	-H "Authorization: Bearer {access_token}"
    @@ -92,7 +92,7 @@

    Request Headers

    Accept: application/fhir+json

    cURL Command to check the job status

    -
    curl -X GET 'https://api.bcda.cms.gov/api/v2/jobs/42' \
    +	
    curl -X GET "https://api.bcda.cms.gov/api/v2/jobs/42" \
     	-H "accept: application/fhir+json" \
     	-H "Authorization: Bearer {access_token}"
    @@ -139,7 +139,7 @@

    Request Headers

    Accept-Encoding: gzip

    cURL Command to download the data

    -
    curl -X GET 'https://api.bcda.cms.gov/data/42/afd22dfa-c239-4063-8882-eb2712f9f638.ndjson' \
    +	
    curl -X GET "https://api.bcda.cms.gov/data/42/afd22dfa-c239-4063-8882-eb2712f9f638.ndjson" \
     	-H "Accept-Encoding: gzip" \
     	-H "Authorization: Bearer {access_token}"
    diff --git a/_includes/build/requesting_data_runouts.html b/_includes/build/requesting_data_runouts.html index 68bcf20..c18930b 100644 --- a/_includes/build/requesting_data_runouts.html +++ b/_includes/build/requesting_data_runouts.html @@ -20,19 +20,19 @@

    Request Headers

    cURL Commands to start a job

    1. -
      curl -X GET 'https://api.bcda.cms.gov/api/v2/Group/runout/$export' \
      +		
      curl -X GET "https://api.bcda.cms.gov/api/v2/Group/runout/$export" \
       	-H "accept: application/fhir+json" \
       	-H "Prefer: respond-async" \
       	-H "Authorization: Bearer {access_token}"
    2. -
      curl -X GET 'https://api.bcda.cms.gov/api/v2/Group/runout/$export?_type=ExplanationOfBenefit,Patient' \
      +		
      curl -X GET "https://api.bcda.cms.gov/api/v2/Group/runout/$export?_type=ExplanationOfBenefit,Patient" \
       	-H "accept: application/fhir+json" \
       	-H "Prefer: respond-async" \
       	-H "Authorization: Bearer {access_token}"
    3. -
      curl -X GET 'https://api.bcda.cms.gov/api/v2/Group/runout/$export?_type=Patient' \
      +		
      curl -X GET "https://api.bcda.cms.gov/api/v2/Group/runout/$export?_type=Patient" \
       	-H "accept: application/fhir+json" \
       	-H "Prefer: respond-async" \
       	-H "Authorization: Bearer {access_token}"
      diff --git a/_includes/build/requesting_filtered_data_since_Group.html b/_includes/build/requesting_filtered_data_since_Group.html index e2efee9..0e2dfd0 100644 --- a/_includes/build/requesting_filtered_data_since_Group.html +++ b/_includes/build/requesting_filtered_data_since_Group.html @@ -17,7 +17,7 @@

      Request Headers

      cURL Command using the _since parameter within the /Group endpoint

      -
      curl -X GET 'https://api.bcda.cms.gov/api/v2/Group/all/$export?_type=Patient&_since=2020-02-13T08:00:00.000-05:00' \
      +	
      curl -X GET "https://api.bcda.cms.gov/api/v2/Group/all/$export?_type=Patient&_since=2020-02-13T08:00:00.000-05:00" \
       	-H "Accept: application/fhir+json" \
       	-H "Prefer: respond-async" \
       	-H "Authorization: Bearer {access_token}"
      diff --git a/_includes/build/requesting_filtered_data_since_Patient.html b/_includes/build/requesting_filtered_data_since_Patient.html index 8fb95fa..7975674 100644 --- a/_includes/build/requesting_filtered_data_since_Patient.html +++ b/_includes/build/requesting_filtered_data_since_Patient.html @@ -13,7 +13,7 @@

      Request Headers

      cURL Command using the _since parameter within the /Patient endpoint

      -
      curl -X GET 'https://api.bcda.cms.gov/api/v2/Patient/$export?_type=Patient&_since=2020-02-13T08:00:00.000-05:00' \
      +	
      curl -X GET "https://api.bcda.cms.gov/api/v2/Patient/$export?_type=Patient&_since=2020-02-13T08:00:00.000-05:00" \
       	-H "Accept: application/fhir+json" \
       	-H "Prefer: respond-async" \
       	-H "Authorization: Bearer {access_token}"
      diff --git a/_includes/guide/bcda_v2.html b/_includes/guide/bcda_v2.html index 5fa0f7d..77ccda2 100644 --- a/_includes/guide/bcda_v2.html +++ b/_includes/guide/bcda_v2.html @@ -20,14 +20,14 @@

      -
      curl -X GET 'https://sandbox.bcda.cms.gov/api/v2/Group/all/$export' \
      +                
      curl -X GET "https://sandbox.bcda.cms.gov/api/v2/Group/all/$export" \
       -H "accept: application/fhir+json" \
       -H "Prefer: respond-async" \
       -H "Authorization: Bearer {access_token}" \
       -v
      -
      curl -X GET 'https://sandbox.bcda.cms.gov/api/v1/Group/all/$export' \
      +                
      curl -X GET "https://sandbox.bcda.cms.gov/api/v1/Group/all/$export" \
       -H "accept: application/fhir+json" \
       -H "Prefer: respond-async" \
       -H "Authorization: Bearer {access_token}" \
      diff --git a/_includes/guide/try_the_api.html b/_includes/guide/try_the_api.html
      index 226d78b..795294b 100644
      --- a/_includes/guide/try_the_api.html
      +++ b/_includes/guide/try_the_api.html
      @@ -73,7 +73,7 @@ 

      Sample cURL Command to Submit Credentials for an Access Token

      -
      curl -d '' -X POST 'https://sandbox.bcda.cms.gov/auth/token' \
      +
      curl -d "" -X POST "https://sandbox.bcda.cms.gov/auth/token" \
       	--user 2462c96b-6427-4efb-aed7-118e20c2e997:8e87f0ebc50d10f1bc9734329a9900179b84ccd39e4d0920b905cc359cf6e94a6e760bbe3a0890c7 \
       	-H "accept: application/json"
      @@ -110,7 +110,7 @@

      Sample cURL Command to Start a Job

      -
      curl -X GET 'https://sandbox.bcda.cms.gov/api/v2/Group/all/$export' \
      +
      curl -X GET "https://sandbox.bcda.cms.gov/api/v2/Group/all/$export" \
       -H "accept: application/fhir+json" \
       -H "Prefer: respond-async" \
       -H "Authorization: Bearer {access_token}" \
      @@ -148,7 +148,7 @@ 

      Sample cURL Command to Check the Job Status

      -
      curl -X GET 'https://sandbox.bcda.cms.gov/api/v2/jobs/42' \
      +
      curl -X GET "https://sandbox.bcda.cms.gov/api/v2/jobs/42" \
       -H "accept: application/fhir+json" \
       -H "Authorization: Bearer {access_token}"
       
      @@ -203,7 +203,7 @@

      Sample cURL Command to Download the Data

      -
      curl 'https://sandbox.bcda.cms.gov/data/42/afd22dfa-c239-4063-8882-eb2712f9f638.ndjson' \
      +
      curl "https://sandbox.bcda.cms.gov/data/42/afd22dfa-c239-4063-8882-eb2712f9f638.ndjson" \
       -H "Authorization: Bearer {access_token}" \
       -H "Accept-Encoding: gzip"
       
      diff --git a/_includes/partial/faq.html b/_includes/partial/faq.html index b7b5988..e96a276 100644 --- a/_includes/partial/faq.html +++ b/_includes/partial/faq.html @@ -58,7 +58,7 @@

      Access to the Claim and ClaimResponse resources is handled within BCDA on a per ACO (Accountable Care Organization) ID level. There are no required changes to credentials for those REACH ACOs who would like access to the V2 endpoint. The BCDA V2 service supports the same functionality as V1 API endpoints in both the sandbox and production API environments. All V2 endpoints should work as described in the existing BCDA documentation. To transition from V1 to your BCDA V2 endpoints, replace ‘v1’ in the API call URLs with ‘v2’, as in the cURL example below:

      -
      curl -X GET 'https://sandbox.bcda.cms.gov/api/v1/Patient/$export' \
      +
      curl -X GET "https://sandbox.bcda.cms.gov/api/v1/Patient/$export" \
       -H "accept: application/fhir+json" \
       -H "Prefer: respond-async" \
       -H "Authorization: Bearer {access_token}" \