publish api-testing mock server JSON schema (#521)

Co-authored-by: rick <LinuxSuRen@users.noreply.github.com>
LinuxSuRen · Aug 9, 2024 · ad1521b · ad1521b
1 parent b880911
commit ad1521b
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 55 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -2,13 +2,13 @@ name: Hugo Docs
 on:
   push:
     branches:
-    - "master"
+      - "master"
   pull_request:
     branches:
-    - "master"
+      - "master"
     paths:
-    - 'docs/site/**'
-    - 'tools/make/docs.mk'
+      - "docs/site/**"
+      - "tools/make/docs.mk"
 
 permissions:
   contents: read
@@ -17,63 +17,64 @@ jobs:
   docs-lint:
     runs-on: ubuntu-22.04
     steps:
-    - name: Check out code
-      uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29  # v4.1.6
-      with:
-        ref: ${{ github.event.pull_request.head.sha }}
+      - name: Check out code
+        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
 
-    - uses: ./tools/github-actions/setup-deps
+      - uses: ./tools/github-actions/setup-deps
 
-    - name: Run markdown linter
-      uses: nosborn/github-action-markdown-cli@9b5e871c11cc0649c5ac2526af22e23525fa344d  # v3.3.0
-      with:
-        files: docs/site/content/*
-        config_file: ".github/markdown_lint_config.json"
+      - name: Run markdown linter
+        uses: nosborn/github-action-markdown-cli@9b5e871c11cc0649c5ac2526af22e23525fa344d # v3.3.0
+        with:
+          files: docs/site/content/*
+          config_file: ".github/markdown_lint_config.json"
 
-    - name: Install linkinator
-      run: npm install -g linkinator@6.0.4
+      - name: Install linkinator
+        run: npm install -g linkinator@6.0.4
 
-    - name: Check links
-      run: make docs # docs-check-links
+      - name: Check links
+        run: make docs # docs-check-links
 
   docs-build:
     runs-on: ubuntu-latest
     needs: docs-lint
     permissions:
       contents: write
     steps:
-    - name: Git checkout
-      uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29  # v4.1.6
-      with:
-        submodules: true
-        ref: ${{ github.event.pull_request.head.sha }}
-
-    - uses: ./tools/github-actions/setup-deps
-
-    - name: Setup Hugo
-      uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f  # v3.0.0
-      with:
-        hugo-version: 'latest'
-        extended: true
-
-    - name: Setup Node
-      uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8  # v4.1.0
-      with:
-        node-version: '18'
-
-    - name: Install Site Dependencies and Build Site
-      run: |
-        cp docs/api-testing-schema.json docs/site/static/api-testing-schema.json
-        make docs # docs-check-links
-
-    # Upload docs for GitHub Pages
-    - name: Upload GitHub Pages artifact
-      uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa  # v3.0.1
-      with:
-        # Path of the directory containing the static assets.
-        path: docs/site/public
-        # Duration after which artifact will expire in days.
-        # retention-days: # optional, default is 1
+      - name: Git checkout
+        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+        with:
+          submodules: true
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - uses: ./tools/github-actions/setup-deps
+
+      - name: Setup Hugo
+        uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3.0.0
+        with:
+          hugo-version: "latest"
+          extended: true
+
+      - name: Setup Node
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.1.0
+        with:
+          node-version: "18"
+
+      - name: Install Site Dependencies and Build Site
+        run: |
+          cp docs/api-testing-schema.json docs/site/static/api-testing-schema.json
+          cp docs/api-testing-mock-schema.json docs/site/static/api-testing-mock-schema.json
+          make docs # docs-check-links
+
+      # Upload docs for GitHub Pages
+      - name: Upload GitHub Pages artifact
+        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
+        with:
+          # Path of the directory containing the static assets.
+          path: docs/site/public
+          # Duration after which artifact will expire in days.
+          # retention-days: # optional, default is 1
 
   # This workflow contains a single job called "build"
   docs-publish:
@@ -83,16 +84,16 @@ jobs:
 
     # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
     permissions:
-      pages: write      # to deploy to Pages
+      pages: write # to deploy to Pages
       deployments: write
-      id-token: write   # to verify the deployment originates from an appropriate source
+      id-token: write # to verify the deployment originates from an appropriate source
 
     # Deploy to the github-pages environment
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
 
     steps:
-    - name: Deploy to GitHub Pages
-      id: deployment
-      uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e  # v4.0.5
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
diff --git a/pkg/mock/testdata/api.yaml b/pkg/mock/testdata/api.yaml
@@ -1,3 +1,5 @@
+#!api-testing-mock
+# yaml-language-server: $schema=https://linuxsuren.github.io/api-testing/api-testing-mock-schema.json
 objects:
   - name: user
     fields: