Merge pull request #155 from tidepool-org/alex-back-3631-redocly

[BACK-3631] Migrate to redocly

Author: toddkazakov

.markdownlint.yaml

@@ -6,4 +6,7 @@ MD013: false
 
 # MD033/no-inline-html - Inline HTML
 MD033:
-  allowed_elements: [ table, colgroup, col, thead, tbody, tr, th, td ]
+  allowed_elements: [table, colgroup, col, thead, tbody, tr, th, td]
+
+# MD059/Link text should be descriptive
+MD059: false

Makefile

@@ -130,20 +130,15 @@ NPM_TOOLS = \
 	$(NPM_BIN)/redocly \
 	$(NPM_BIN)/spectral \
 	$(NPM_BIN)/stoplight \
-	$(NPM_BIN)/swagger-cli
 
-# TODO: update markdown-link-check version. Right now there's a bug in
-# 3.12.x. 3.11.2 is the latest version before 3.12.x. See
-# https://github.com/tcort/markdown-link-check/issues/304
 NPM_PKG_SPECS = \
-	@apidevtools/swagger-cli@^4.0.4 \
-	@openapi-contrib/json-schema-to-openapi-schema@^2.2.5 \
-	@redocly/cli@^1.0.0-rc.3 \
-	@stoplight/cli@^6.0.1280 \
-	@stoplight/spectral-cli@^6.8.0 \
-	markdown-link-check@3.11.2 \
-	markdownlint-cli@^0.33.0 \
-	openapi-merge-cli@1.3.1
+	@openapi-contrib/json-schema-to-openapi-schema@^3.0.3 \
+	@redocly/cli@1.34.3 \
+	@stoplight/cli@^6.0.2382 \
+	@stoplight/spectral-cli@^6.15.0 \
+	markdown-link-check@3.13.7 \
+	markdownlint-cli@^0.45.0 \
+	openapi-merge-cli@1.3.2
 
 .PHONY: install_npm_pkgs
 install_npm_pkgs:

docs/quick-start/fetching-device-data.md

@@ -43,7 +43,7 @@ You can narrow the fetch query by specifying a type, sub-type and/or date query
 <!-- title: Query Parameters -->
 
 | Parameter | Type | Effect | Example
-| --- | --- | --- | --- |
+| --- | --- | --- | ---
 | Device ID | String | Only objects with a device ID field matching the specified device ID param will be returned. | E.g. `/data/userid?deviceId=abcdef0123456789`
 | End date | String (in ISO-8601 date/time format) | Only objects with time field less than or equal to end date will be returned. | E.g. `?endDate=2015-10-10T15:00:00.000Z`
 | Latest data | Boolean | Returns only the most recent results for each type matching the results filtered by the other query parameters. | All types: `?latest=true` or single type: `?latest=true&type=cbg`
@@ -57,7 +57,7 @@ In addition, there are several “special” parameters that have an effect on t
 <!-- title: Additional Query Parameters -->
 
 | Parameter | Type | Effect | Example
-| --- | --- | --- | --- |
+| --- | --- | --- | ---
 | Carelink | Boolean | Return data from the now-deprecated CareLink import, unless data for the same time period has been uploaded using the Uploader (the device manufacturers field contains the string Medtronic). | E.g. `/data/userid?carelink=true`
 | Dexcom | Boolean | Return CGM data from *only* the Dexcom API, even if other CGM data exists from other sources. | E.g. `/data/userid?dexcom=true`
 | Medtronic | Boolean | Return CGM, Basal and Bolus data from Medtronic Uploads, provided that data exists after `2017-09-01`. Unless data from a Medtronic device has been uploaded by Loop via HealthKit (`origin.payload.device.manufacturer` is Medtronic), and that data exists after `2017-09-01`. | E.g. `/data/userid?medtronic=true`
@@ -99,7 +99,7 @@ So, you have three time ranges that apply here:
 <!-- title: Time Ranges -->
 
 | Start Time | End Time | CGM Data Returned
-| --- | --- | --- |
+| --- | --- | ---
 | Beginning of Time | Dexcom API Earliest Data Time | All CGM Data
 | Dexcom API Earliest Data Time | Dexcom API Latest Data Time |   Only Dexcom API CGM Data
 | Dexcom API Latest Data Time | End of Time | All CGM data

docs/summary-data.md

@@ -16,7 +16,7 @@
 
 ---
 
-# Overview
+## Overview
 
 Tidepool Platform automatically calculates several summary statistics for each user as they upload diabetes data into their account. Currently supported data types are CGM and BGM, from [Continuous Glucose Monitors][cgm] and [Blood Glucose Meters][bgm], respectively. Our plan is to add insulin delivery summaries as well in the future.
 
@@ -51,7 +51,7 @@ sequenceDiagram
    Platform->>Clinic: Summary available via patient list
 ```
 
-# Calculation
+## Calculation
 
 The summary calculation is done in batches of up to 250 most out-of-date user accounts, up to 4 batches in one iteration, where each iteration may begin every 30 seconds. Thus, each calculation iteration may update up to 1,000 accounts. The calculation for each user proceeds as shown in the diagram below:
 

reference/auth.v1.yaml

@@ -62,7 +62,7 @@ paths:
       summary: Refresh Session Token
       description: |-
         **This API is deprecated and will be removed by end of 2023.**
-        Refreshes an existing session token.        
+        Refreshes an existing session token.
       responses:
         '200':
           $ref: '#/components/responses/TokenData'
@@ -405,7 +405,7 @@ paths:
     get:
       operationId: VerifyDeviceToken
       summary: Verify Device Token
-      description: 'Checks the validity of Apple''s DeviceCheck token by calling Apple''s server to verify it. For more details, see Apple''s [developer documentation](https://developer.apple.com/documentation/devicecheck).'
+      description: "Checks the validity of Apple's DeviceCheck token by calling Apple's server to verify it. For more details, see Apple's [developer documentation](https://developer.apple.com/documentation/devicecheck)."
       requestBody:
         $ref: '#/components/requestBodies/VerifyDeviceToken'
       responses:
@@ -547,7 +547,7 @@ paths:
       parameters:
         - $ref: ./common/parameters/paginationpage.v1.yaml
         - $ref: ./common/parameters/paginationsize.v1.yaml
-        - $ref: ./auth/parameters/providers/name.v1.yaml
+        - $ref: ./auth/parameters/providers/providerName.v1.yaml
         - $ref: ./auth/parameters/providers/provider-type.v1.yaml
       responses:
         '200':

reference/auth/models/providers/newsession.v1.yaml

@@ -4,7 +4,7 @@ description: >-
 type: object
 properties:
   name:
-    $ref: './name.v1.yaml'
+    $ref: './providerName.v1.yaml'
   type:
     $ref: './provider-type.v1.yaml'
   oauthToken:

…rence/auth/models/providers/name.v1.yaml …th/models/providers/providerName.v1.yamlreference/auth/models/providers/name.v1.yaml renamed to reference/auth/models/providers/providerName.v1.yaml reference/auth/models/providers/name.v1.yaml renamed to reference/auth/models/providers/providerName.v1.yaml

@@ -10,7 +10,7 @@ properties:
   modifiedTime:
     $ref: '../../../common/models/datetime.v1.yaml'
   name:
-    $ref: './name.v1.yaml'
+    $ref: './providerName.v1.yaml'
   oauthToken:
     $ref: './oauthtoken.v1.yaml'
   type:

reference/auth/models/providers/session.v1.yaml

@@ -4,4 +4,4 @@ name: name
 in: query
 required: false
 schema:
-  $ref: '../../models/providers/name.v1.yaml'
+  $ref: '../../models/providers/providerName.v1.yaml'