#24104 script for checking excluded snippets

.github/check-excluded-snippets.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+filelist=$(find ./docs -type f -name "*.md")
+pattern='```'
+
+
+for file in $filelist
+do
+
+    for line in $(grep -Fn $pattern $file | sed -e's/:.*//' | sed -n 'n;p')
+    do
+        if  ! [[ $(awk "NR==$line+1" $file) == *"{ data-search-exclude }"* || $(awk "NR==$line+2" $file) == *"{ data-search-exclude }"* ]]; then
+            echo "Snippet in line $line in file $file is not excluded from search" >> status.txt
+        fi
+    done
+done
+
+if [ -s "status.txt" ]  || [ -f "status.txt" ] ;then
+    cat status.txt
+    exit 7
+else
+    echo "Every snippet has been excluded from search results"
+fi
+

.github/workflows/snippet-check.yml

@@ -0,0 +1,15 @@
+name: Snippet check script
+# Controls when the action will run. Triggers the workflow on push
+# events but only for the master branch
+on:
+  pull_request
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest # The type of runner that the job will run on
+    steps: # Steps represent a sequence of tasks that will be executed as part of the job
+    - name: Check out the repository
+      uses: actions/checkout@v2
+    - name: Run the script
+      run: .github/check-excluded-snippets.sh

docs/API/content-type/creating-co.md

@@ -27,6 +27,8 @@ to the supporting endpoint `https://api.flotiq.com/api/v1/content/{name}`
   "postContent": "This will be the new <b>content</b>"
 }
 ```
+{ data-search-exclude }
+
 !!! note
     The maximum size of a single CO in the system is 1MB. If your project requires a larger CO size, please contact Flotiq support.
 

docs/API/content-type/updating-co.md

@@ -32,6 +32,8 @@ to the supporting endpoint `https://api.flotiq.com/api/v1/content/{name}/{id}` t
   "postContent": "This will be the new <b>content</b>"
 }
 ```
+{ data-search-exclude }
+
 
 * `name` is the name of the content type definition
 * `id` is the ID of the object to update

docs/API/generate-package.md

@@ -31,13 +31,15 @@ Flotiq always provides your up-to-date API definition in an OpenAPI 3.0 compatib
 ``` shell
 npm install @openapitools/[email protected] -g
 ```
+{ data-search-exclude }
 
 
 This will instal the OpenAPI generator that will allow you to generate more packages. List of supported generators is mentioned [here](https://openapi-generator.tech/docs/generators)
 
 ```
 openapi-generator generate -g <name> -i <path_to_open_api_schema_json> --skip-validate-spec -o <output_path>
 ```
+{ data-search-exclude }
 
 Parameters description:
 

docs/API/generate-package/sdk-nodejs.md

@@ -84,21 +84,25 @@ by changing into the directory containing package.json (and this README). Let's
 ```shell
 npm install
 ```
+{ data-search-exclude }
 
 Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:
 
 ```shell
 npm link
 ```
+{ data-search-exclude }
 
 To use the link you just defined in your project, switch to the directory you want to use your flotiq_user_api from, and run:
 
 ```shell
 npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
 ```
+{ data-search-exclude }
 
 Finally, you need to build the module:
 
 ```
 npm run build
 ```
+{ data-search-exclude }

docs/API/open-api-schema.md

@@ -24,6 +24,7 @@ curl -X GET "https://api.flotiq.com/api/v1/open-api-schema.json" \
      -H 'X-AUTH-TOKEN: YOUR_API_KEY' \
      -H 'Content-Type: application/json'
 ```
+{ data-search-exclude }
 
 Possible request parameters:
 
@@ -51,6 +52,7 @@ as not all tools can handle the whole Open API Schema format.
          -H 'X-AUTH-TOKEN: YOUR_API_KEY' \
          -H 'Content-Type: application/json'
     ```
+    { data-search-exclude }
 
     Response
     ```
@@ -3346,6 +3348,7 @@ as not all tools can handle the whole Open API Schema format.
          -H 'X-AUTH-TOKEN: YOUR_API_KEY' \
          -H 'Content-Type: application/json'
     ```
+    { data-search-exclude }
 
     Response
 
@@ -4424,6 +4427,7 @@ as not all tools can handle the whole Open API Schema format.
          -H 'X-AUTH-TOKEN: YOUR_API_KEY' \
          -H 'Content-Type: application/json'
     ```
+    { data-search-exclude }
 
     Response
     ```
@@ -7287,7 +7291,8 @@ as not all tools can handle the whole Open API Schema format.
          -H 'X-AUTH-TOKEN: YOUR_API_KEY' \
          -H 'Content-Type: application/json'
     ```
-
+    { data-search-exclude }
+
     Response
     ```
     {

docs/API/search.md

@@ -29,7 +29,7 @@ Request:
 ```
 GET https://api.flotiq.com/api/v1/search?q=Flotiq&content_type[]=post
 ```
-
+{ data-search-exclude }
 
 Response:
 ```json