FD-880: Migrate redoc-cli to @redocly/cli

.github/workflows/cd.yml

@@ -18,17 +18,15 @@ jobs:
           node-version-file: ".node-version"
 
       - name: bundle
-        uses: hilary/openapi-cli-bundle-action@v0.0.2
-        with:
-          base-spec: "./lob-api-public.yml"
-          bundled-spec: "dist/lob-api-bundled.yml"
-
-      - name: build zero-dependency docs
         shell: bash
         run: |
           set -x
-          npm i redoc-cli --save-dev && npx patch-package
-          npm run redoc
+          npm ci
+          npm run bundle
+
+      - name: build docs
+        shell: bash
+        run: npm run redoc
 
       - name: build postman collection
         uses: ./actions/contract_tests
@@ -37,8 +35,3 @@ jobs:
         env:
           LOB_API_TEST_TOKEN: ${{ secrets.LOB_API_TEST_TOKEN }}
           LOB_API_LIVE_TOKEN: ${{ secrets.LOB_API_LIVE_TOKEN }}
-
-      - name: Extract branch name
-        shell: bash
-        run: echo "branch=${GITHUB_REF#refs/heads/}" >> "$GITHUB_OUTPUT"
-        id: extract_branch

.github/workflows/ci.yml

@@ -22,8 +22,8 @@ jobs:
         shell: bash
         run: |
           set -x
-          npm i prettier
-          npm run pretty
+          npm ci
+          npm run pretty:check
 
       - name: integration tests
         shell: bash

.redocly.yaml

@@ -4,5 +4,36 @@ rules:
   boolean-parameter-prefixes: off
   no-invalid-media-type-examples:
     severity: warn
-    disallowAdditionalProperties: false
+    allowAdditionalProperties: true
   no-enum-type-mismatch: off
+openapi:
+  noAutoAuth: true
+  maxDisplayedEnumValues: 15
+  expandResponses: "200,201"
+  jsonSampleExpandLevel: 3
+  requiredPropsFirst: true
+  hideDownloadButton: true
+  theme:
+    colors:
+      primary:
+        main: "#27333c"
+    sidebar:
+      backgroundColor: "#f7f9fa"
+    typography:
+      code:
+        backgroundColor: "#ebf0f6"
+        fontFamily: JetBrainsMono
+        color: "#27333c"
+      links:
+        color: "#0099d7"
+        textDecoration: none
+      fontFamily: "Larsseit, sans-serif"
+      fontSize: "16px"
+      headings:
+        fontFamily: "Larsseit, sans-serif"
+        fontWeight: "300"
+    codeBlock:
+      backgroundColor: "#ecf0f5"
+    rightPanel:
+      backgroundColor: "#f7f9fa"
+      textColor: "#416581"

docs/README.md

@@ -1,14 +1,14 @@
 # Developer Documentation
 
-This directory contains a zero-dependency, single file version of our new developer docs for Lob API v1.
+This directory contains a single file version of our developer docs for Lob API v1.
 
 ## Github Pages
 
 The copy in main is served by Github pages at https://lob.github.io/lob-openapi.
 
 ## How it is built
 
-The docs are generated from the OpenAPI v3 description in this repo using `redoc-cli`. See also the `redoc` script in
+The docs are generated from the OpenAPI v3 description in this repo using `@redocly/cli`. See also the `redoc` script in
 `package.json`. The file is updated on each push to github.
 
 You can generate the file yourself at any time by running `npm run redoc`.