chore(docs): Refactor API Reference (#1883)

.github/workflows/generate-api-reference.yml

@@ -0,0 +1,51 @@
+name: Generate API Reference
+on: 
+  pull_request:
+    types:
+      - closed
+    branches:
+      - "master"
+    paths:
+      - packages/medusa/src/api/routes/**
+      - '!packages/medusa/src/api/routes/**/index.ts'
+      - '!packages/medusa/src/api/routes/**/index.js'
+jobs:
+  api:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.9.1
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Checkout
+        uses: actions/checkout@v2.3.5
+        with:
+          token: ${{ secrets.REFERENCE_PAT }}
+          fetch-depth: 0
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v2.4.1
+        with:
+          node-version: "14"
+          cache: "yarn"
+
+      - name: Install dependencies
+        uses: ./.github/actions/cache-deps
+        with:
+          extension: reference
+
+      - name: Build Packages
+        run: yarn build
+
+      - name: Generate API Reference
+        run: yarn openapi:generate
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: 'chore(docs): Generated API Reference'
+          base: 'master'
+          title: 'chore(docs): Updated API Reference'
+          labels: 'type: chore'
+          add-paths: docs/api/*

.github/workflows/generate-js-reference.yml

@@ -46,8 +46,8 @@ jobs:
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v4
         with:
-          commit-message: 'docs: Generated JS Client Reference (automated)'
+          commit-message: 'chore(docs): Generated JS Client Reference (automated)'
           base: 'master'
-          title: 'docs: Generated JS Client Reference (automated)'
-          labels: 'type: docs'
+          title: 'chore(docs): Updated API Reference'
+          labels: 'type: chore'
           add-paths: docs/content/references/js-client/**

.github/workflows/generate-reference.yml

@@ -46,8 +46,8 @@ jobs:
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v4
         with:
-          commit-message: 'docs: Generated Services Reference (automated)'
+          commit-message: 'chore(docs): Generated Services Reference (automated)'
           base: 'master'
-          title: 'docs: Generated Services Reference (automated)'
-          labels: 'type: docs'
+          title: 'chore(docs): Generated Services Reference (automated)'
+          labels: 'type: chore'
           add-paths: docs/content/references/services/**

.github/workflows/oas-test.yml

@@ -0,0 +1,34 @@
+name: OAS Comments Format Validation
+on: 
+  pull_request:
+    paths:
+      - packages/medusa/src/api/routes/**
+
+jobs:
+  docs-test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.9.1
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Checkout
+        uses: actions/checkout@v2.3.5
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v2.4.1
+        with:
+          node-version: "14"
+          cache: "yarn"
+
+      - name: Install dependencies
+        uses: ./.github/actions/cache-deps
+        with:
+          extension: oas
+
+      - name: Build OAS
+        run: |
+          yarn openapi:generate