Merge main to oas release (#535)

Co-authored-by: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com>
Co-authored-by: mchatlas-hellosign <mchatlas@dropbox.com>
Co-authored-by: Juan Treminio <juantreminio@dropbox.com>
Co-authored-by: Sainish Momin <130490494+sainishm2@users.noreply.github.com>
Co-authored-by: suchcicki-dropbox <suchcicki@dropbox.com>
Co-authored-by: agornydbx <agorny@dropbox.com>
Co-authored-by: mwojcik-dropbox <mwojcik@dropbox.com>
Co-authored-by: Brian Erkkinen <brianerkkinen@hellosign.com>

Author: 8 people

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

bin/redoc-container

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+#
+# instructions:
+#   run this script
+#   open http://127.0.0.1:8081
+#
+# Prefer to use ./redoc - this version does not auto-reload changes
+
+set -e
+
+DIR=$(cd `dirname $0` && pwd)
+ROOT_DIR="${DIR}/.."
+
+echo "Docs will be available at http://localhost:8081/"
+
+docker run -it --rm -p 8081:80 \
+  -v "${ROOT_DIR}:/usr/share/nginx/html/swagger/" \
+  -e SPEC_URL=swagger/openapi.yaml \
+  -e REDOC_OPTIONS="required-props-first=1 path-in-middle-panel=1" \
+  redocly/redoc

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}

examples/SignatureRequestCreateEmbeddedExample.cs

@@ -22,7 +22,8 @@ public static void Run()
             draw: true,
             phone: false,
             type: true,
-            upload: true
+            upload: true,
+            force_advanced_signature_details: false
         );
 
         var signers1 = new SubSignatureRequestSigner(

examples/SignatureRequestCreateEmbeddedExample.java

@@ -29,6 +29,7 @@ public static void main(String[] args)
         signingOptions.phone(false);
         signingOptions.type(true);
         signingOptions.upload(true);
+        signingOptions.forceAdvancedSignatureDetails(false);
 
         var signers1 = new SubSignatureRequestSigner();
         signers1.name("Jack");

examples/SignatureRequestCreateEmbeddedExample.php

@@ -16,7 +16,8 @@
     ->setDraw(true)
     ->setPhone(false)
     ->setType(true)
-    ->setUpload(true);
+    ->setUpload(true)
+    ->setForceAdvancedSignatureDetails(false);
 
 $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner())
     ->setName("Jack")

examples/SignatureRequestCreateEmbeddedExample.py

@@ -16,6 +16,7 @@
         phone=False,
         type=True,
         upload=True,
+        force_advanced_signature_details=False,
     )
 
     signers_1 = models.SubSignatureRequestSigner(

examples/SignatureRequestCreateEmbeddedExample.rb

@@ -12,6 +12,7 @@
 signing_options.phone = false
 signing_options.type = true
 signing_options.upload = true
+signing_options.force_advanced_signature_details = false
 
 signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new
 signers_1.name = "Jack"

examples/SignatureRequestCreateEmbeddedExample.sh

@@ -18,4 +18,5 @@ curl -X POST 'https://api.hellosign.com/v3/signature_request/create_embedded' \
   -F 'signing_options[upload]=1' \
   -F 'signing_options[phone]=1' \
   -F 'signing_options[default_type]=draw' \
+  -F 'signing_options[force_advanced_signature_details]=0' \
   -F 'test_mode=1'