ci: remove internally marked variables

The bundled and filtered spec hosted on pages should be used for SDK- and documentation-generation instead of the raw one.

Author: Foorack

.github/redocly-plugins/remove-internal.js

@@ -0,0 +1,55 @@
+const id = 'remove-internal';
+
+/** @type {import('@redocly/openapi-cli').CustomRulesConfig} */
+const decorators = {
+    oas3: {
+        'remove-internal': () => {
+            return {
+                PathItem: {
+                    leave(pathItem, ctx) {
+                        // delete if the path itself is marked with x-internal
+                        if (pathItem['x-internal']) {
+                            delete ctx.parent[ctx.key];
+                        }
+
+                        // delete any operations inside of a path marked with x-internal
+                        const operations = ['get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace'];
+                        for (const operation of operations) {
+                            if (pathItem[operation] && pathItem[operation]['x-internal']) {
+                                delete pathItem[operation];
+                            }
+                        }
+
+                        // delete the path if there are no operations remaining in it
+                        if (Object.keys(pathItem).length === 0) {
+                            delete ctx.parent[ctx.key];
+                        }
+                    }
+                },
+                Parameter: {
+                    leave(parameter, ctx) {
+                        // delete if the parameter itself is marked with x-internal
+                        if (parameter['x-internal']) {
+                            delete ctx.parent[ctx.key];
+                        }
+                    }
+                },
+                SchemaProperties: {
+                    leave(properties, ctx) {
+                        for (const [key, object] of Object.entries(properties)) {
+                            //console.log(`${key}: ${object}`);
+                            if (object['x-internal']) {
+                                delete properties[key];
+                            }
+                        }
+                    }
+                }
+            }
+        },
+    },
+};
+
+module.exports = {
+    id,
+    decorators,
+};

.github/workflows/ci.yaml

@@ -1,5 +1,5 @@
 on: [push, pull_request]
-name: Continuous Integration
+name: OpenAPI Specification CI
 
 jobs:
   lint:
@@ -24,18 +24,24 @@ jobs:
 
   bundle:
     runs-on: ubuntu-latest
-    name: Bundle OpenAPI specification
+    name: Bundle and Upload OpenAPI specification
     steps:
       - uses: actions/checkout@v2
 
-      - name: OpenAPI CLI Bundle
+      - name: Bundle OpenAPI Specification 📦
         uses: hilary/[email protected]
         with:
-          base-spec: openapi.yaml
+          base-spec: openapi/openapi.yaml
           bundled-spec: dist/openapi-bundled.yml
 
-      - name: Store bundled specification
+      - name: Upload Bundled Specification as Artifact 📤
         uses: actions/upload-artifact@v2
         with:
           name: openapi-bundled
-          path: dist/openapi-bundled.yml
+          path: dist/openapi-bundled.yml
+
+      - name: Deploy Bundle to Github Pages 🚀
+        uses: JamesIves/[email protected]
+        with:
+          branch: master
+          folder: dist

.redocly.yaml

@@ -0,0 +1,10 @@
+# See https://redoc.ly/docs/cli/configuration/ for more information.
+apiDefinitions:
+  main: openapi/openapi.yaml
+lint:
+  extends:
+    - recommended
+  plugins:
+    - './.github/redocly-plugins/remove-internal.js'
+  decorators:
+    remove-internal/remove-internal: error