Merge branch 'main' of github-hellosign:hellosign/hellosign-openapi into merge-main-to-oas-release

Author: adanilowski-dropbox

bin/copy-examples-filtered

@@ -0,0 +1,46 @@
+#!/usr/bin/env bash
+#
+# Copies example files from src_dir to dst_dir, skipping any whose operationId
+# exists in openapi-raw.yaml but not in openapi-sdk.yaml (i.e. endpoints hidden
+# from the SDK via the x-hideOn: sdk attribute). Matching is by PascalCase
+# filename: an operationId "templateUpdate" maps to "TemplateUpdateExample.<ext>".
+
+set -e
+
+DIR=$(cd "$(dirname "$0")" && pwd)
+ROOT_DIR="${DIR}/.."
+
+SRC_DIR="$1"
+DST_DIR="$2"
+EXT="$3"
+
+if [[ -z "$SRC_DIR" || -z "$DST_DIR" || -z "$EXT" ]]; then
+  printf "Usage: copy-examples-filtered <src_dir> <dst_dir> <file_extension>\n"
+  exit 1
+fi
+
+HIDDEN_PASCALS=()
+while IFS= read -r OP; do
+  [ -z "$OP" ] && continue
+  HIDDEN_PASCALS+=("$(echo "${OP:0:1}" | tr 'a-z' 'A-Z')${OP:1}")
+done < <(comm -23 \
+  <(grep 'operationId:' "${ROOT_DIR}/openapi-raw.yaml" | sed 's/.*operationId: //' | sort) \
+  <(grep 'operationId:' "${ROOT_DIR}/openapi-sdk.yaml" | sed 's/.*operationId: //' | sort))
+
+for FILE in "${SRC_DIR}"/*."${EXT}"; do
+  [ -f "$FILE" ] || continue
+  BASENAME=$(basename "$FILE" ".$EXT")
+
+  SKIP=0
+  for PASCAL in "${HIDDEN_PASCALS[@]}"; do
+    if [ "$BASENAME" = "${PASCAL}Example" ]; then
+      SKIP=1
+      printf "  Skipping (hidden from SDK): %s\n" "$(basename "$FILE")"
+      break
+    fi
+  done
+
+  if [ $SKIP -eq 0 ]; then
+    cp "$FILE" "$DST_DIR/"
+  fi
+done

build

@@ -14,11 +14,11 @@ printf "\n"
 
 bash "${DIR}/bin/php" ./bin/generate-oas.php
 
-cp "${DIR}/examples/"*.cs "${DIR}/sandbox/dotnet/src/Dropbox.SignSandbox/"
-cp "${DIR}/examples/"*.java "${DIR}/sandbox/java/src/main/java/com/dropbox/sign_sandbox/"
-cp "${DIR}/examples/"*.php "${DIR}/sandbox/php/src/"
-cp "${DIR}/examples/"*.py "${DIR}/sandbox/python/src/"
-cp "${DIR}/examples/"*.rb "${DIR}/sandbox/ruby/src/"
-cp "${DIR}/examples/"*.ts "${DIR}/sandbox/node/src/"
+"${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${DIR}/sandbox/dotnet/src/Dropbox.SignSandbox" cs
+"${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${DIR}/sandbox/java/src/main/java/com/dropbox/sign_sandbox" java
+"${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${DIR}/sandbox/php/src" php
+"${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${DIR}/sandbox/python/src" py
+"${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${DIR}/sandbox/ruby/src" rb
+"${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${DIR}/sandbox/node/src" ts
 
 printf "Success!\n"

copy-sdks

@@ -122,17 +122,17 @@ function copy_files()
   cp -r "${DIR}/openapi-sdk.yaml" "${SDK_DIR}/openapi-sdk.yaml"
 
   if [[ "${SDK}" == "dotnet" ]]; then
-    cp -r "${DIR}/examples/"*.cs "${SDK_DIR}/examples/"
+    "${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${SDK_DIR}/examples" cs
   elif [[ "${SDK}" == "java-v2" ]] || [[ "${SDK}" == "java-v1" ]]; then
-    cp -r "${DIR}/examples/"*.java "${SDK_DIR}/examples/"
+    "${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${SDK_DIR}/examples" java
   elif [[ "${SDK}" == "node" ]]; then
-    cp -r "${DIR}/examples/"*.ts "${SDK_DIR}/examples/"
+    "${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${SDK_DIR}/examples" ts
   elif [[ "${SDK}" == "php" ]]; then
-    cp -r "${DIR}/examples/"*.php "${SDK_DIR}/examples/"
+    "${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${SDK_DIR}/examples" php
   elif [[ "${SDK}" == "python" ]]; then
-    cp -r "${DIR}/examples/"*.py "${SDK_DIR}/examples/"
+    "${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${SDK_DIR}/examples" py
   elif [[ "${SDK}" == "ruby" ]]; then
-    cp -r "${DIR}/examples/"*.rb "${SDK_DIR}/examples/"
+    "${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${SDK_DIR}/examples" rb
   fi
 
   php "${DIR}/bin/update-sdk-version.php" ${SDK} ${VERSION}

generate-sdks

@@ -155,17 +155,17 @@ function copy_examples()
   mkdir -p "${SDK_DIR}/examples"
 
   if [[ "${SDK}" == "dotnet" ]]; then
-    cp -r "${DIR}/sandbox/dotnet/src/Dropbox.SignSandbox/"*.cs "${SDK_DIR}/examples/"
+    "${DIR}/bin/copy-examples-filtered" "${DIR}/sandbox/dotnet/src/Dropbox.SignSandbox" "${SDK_DIR}/examples" cs
   elif [[ "${SDK}" == "java-v2" || "${SDK}" == "java-v1" ]]; then
-    cp -r "${DIR}/sandbox/java/src/main/java/com/dropbox/sign_sandbox/"*.java "${SDK_DIR}/examples/"
+    "${DIR}/bin/copy-examples-filtered" "${DIR}/sandbox/java/src/main/java/com/dropbox/sign_sandbox" "${SDK_DIR}/examples" java
   elif [[ "${SDK}" == "node" ]]; then
-    cp -r "${DIR}/sandbox/node/src/"*.ts "${SDK_DIR}/examples/"
+    "${DIR}/bin/copy-examples-filtered" "${DIR}/sandbox/node/src" "${SDK_DIR}/examples" ts
   elif [[ "${SDK}" == "php" ]]; then
-    cp -r "${DIR}/sandbox/php/src/"*.php "${SDK_DIR}/examples/"
+    "${DIR}/bin/copy-examples-filtered" "${DIR}/sandbox/php/src" "${SDK_DIR}/examples" php
   elif [[ "${SDK}" == "python" ]]; then
-    cp -r "${DIR}/sandbox/python/src/"*.py "${SDK_DIR}/examples/"
+    "${DIR}/bin/copy-examples-filtered" "${DIR}/sandbox/python/src" "${SDK_DIR}/examples" py
   elif [[ "${SDK}" == "ruby" ]]; then
-    cp -r "${DIR}/sandbox/ruby/src/"*.rb "${SDK_DIR}/examples/"
+    "${DIR}/bin/copy-examples-filtered" "${DIR}/sandbox/ruby/src" "${SDK_DIR}/examples" rb
   fi
 }
 

openapi-raw.yaml

@@ -7289,6 +7289,7 @@ paths:
       x-hideOn:
         - doc
         - sdk
+      x-beta: closed
   '/template/update_files/{template_id}':
     post:
       tags: