Upload APIs to Readme platform and add github actions for them

bloomreach · Mar 20, 2024 · f534f0d · f534f0d
1 parent aef0e8f
commit f534f0d
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 18 deletions.
diff --git a/.github/workflows/readme.yaml b/.github/workflows/readme.yaml
@@ -1,15 +1,43 @@
-# For info on getting the latest rdme version and obtaining your API_DEFINITION_ID,
-# see our docs: https://docs.readme.com/docs/rdme#example-syncing-an-openapi-definition
 name: Sync OAS to ReadMe
+
 on:
   push:
     branches:
       - main
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: readmeio/[email protected]
-        with:
-          rdme: openapi discovery/email_spec.yaml --key=${{ secrets.API_KEY_SANDBOX }} --id=${{ secrets.EMAIL_RECS_ID }}
+
+    jobs:
+      rdme-openapi:
+        runs-on: ubuntu-latest
+        steps:
+          - name: Check out repo 📚
+            uses: actions/checkout@v3
+
+          - name: Upload Autosuggest API to Readme
+            uses: readmeio/rdme@v8
+            with:
+              rdme: openapi discovery/autosuggest.yaml --key=${{ secrets.README_API_KEY }} --id=${{ secrets.AUTOSUGGEST_ID }}
+
+          - name: Upload Bestseller API to Readme
+            uses: readmeio/rdme@v8
+            with:
+              rdme: openapi discovery/bestseller.yaml --key=${{ secrets.README_API_KEY }} --id=${{ secrets.BESTSELLER_ID }} 
+
+          - name: Upload Content Search API to Readme
+            uses: readmeio/rdme@v8
+            with:
+              rdme: openapi discovery/content-search.yaml --key=${{ secrets.README_API_KEY }} --id=${{ secrets.CONTENT_SEARCH_ID }}
+
+          - name: Upload Recommendations & Pathways API to Readme
+            uses: readmeio/rdme@v8
+            with:
+              rdme: openapi discovery/recommendations-pathways.yaml --key=${{ secrets.README_API_KEY }} --id=${{ secrets.RECS_PATHWAYS_ID }}
+
+          - name: Upload Search & Category API to Readme
+            uses: readmeio/rdme@v8
+            with:
+              rdme: openapi discovery/search-category.yaml --key=${{ secrets.README_API_KEY }} --id=${{ secrets.SEARCH_CATEGORY_ID }}
+
+          - name: Upload Email Widget API to Readme
+            uses: readmeio/rdme@v8
+            with:
+              rdme: openapi discovery/email-spec.yaml --key=${{ secrets.README_API_KEY }} --id=${{ secrets.EMAIL_RECS_ID }}
diff --git a/discovery/README.md b/discovery/README.md
diff --git a/discovery/content-search.yaml b/discovery/content-search.yaml
@@ -248,4 +248,3 @@ x-readme:
   proxy-enabled: true
   samples-enabled: true
 x-readme-fauxas: true
-            default: contentskodemo_64ae
diff --git a/discovery/recommendations-pathways.yaml b/discovery/recommendations-pathways.yaml
@@ -80,7 +80,6 @@ paths:
             Do not use a relative URL. <br><br> The example value shown here, <i>https://www.documentation-site.com</i>,
             is included for your convenience to send a request with <b>Try It</b>.
           required: true
-          example: '4500928'
           example: https://www.documentation-site.com
           schema:
             type: string
@@ -1214,12 +1213,26 @@ paths:
       description: ''
       operationId: upload-api
       deprecated: false
+      parameters: 
+        - name: widget_id
+          in: path
+          required: true
+          description: The ID of the widget.
+          schema:
+            type: string
   "/visual/search/{widget_id}":
     get:
       summary: Visual Search API
       description: ''
       operationId: visual-search-response-api
       deprecated: false
+      parameters: 
+        - name: widget_id
+          in: path
+          required: true
+          description: The ID of the widget.
+          schema:
+            type: string
 x-readme:
   headers: [ ]
   explorer-enabled: true

diff --git a/discovery/search-category.yaml b/discovery/search-category.yaml
@@ -89,12 +89,12 @@ paths:
             convenience to send a request with <b>Try It</b>.
           required: true
           examples: 
-          product: 
-          value: cable
-          summary: Search terms
-          category: 
-          value: PNB160303000000
-          summary: Category ID 
+            product: 
+              value: cable
+              summary: Search terms
+            category: 
+              value: PNB160303000000
+              summary: Category ID 
           schema:
             type: string
         - name: ref_url