From c54f57716690de34ffb2956910b7a199d3d7fc09 Mon Sep 17 00:00:00 2001 From: Juan Treminio Date: Thu, 12 Dec 2024 18:26:14 -0600 Subject: [PATCH 1/2] Some fixes for the OAS --- examples/json/FaxLineDeleteRequestExample.json | 2 +- examples/json/FaxSendRequestExample.json | 4 ++-- openapi-raw.yaml | 6 ++++++ openapi-sdk.yaml | 6 ++++++ openapi.yaml | 6 ++++++ .../src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj | 2 +- 6 files changed, 22 insertions(+), 4 deletions(-) diff --git a/examples/json/FaxLineDeleteRequestExample.json b/examples/json/FaxLineDeleteRequestExample.json index 4bc5f0b67..1ffef7fe5 100644 --- a/examples/json/FaxLineDeleteRequestExample.json +++ b/examples/json/FaxLineDeleteRequestExample.json @@ -1,3 +1,3 @@ { - "number": "[FAX_NUMBER]", + "number": "[FAX_NUMBER]" } diff --git a/examples/json/FaxSendRequestExample.json b/examples/json/FaxSendRequestExample.json index fe7e68820..4b4ac16b3 100644 --- a/examples/json/FaxSendRequestExample.json +++ b/examples/json/FaxSendRequestExample.json @@ -1,5 +1,5 @@ { - "file_url": [ + "file_urls": [ "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" ], "test_mode": "true", @@ -9,4 +9,4 @@ "cover_page_message": "I'm sending you a fax!", "cover_page_from": "Faxer Faxerson", "title": "This is what the fax is about!" -} \ No newline at end of file +} diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 3523daada..24bcdd147 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -1820,6 +1820,7 @@ paths: - CA - US - UK + example: US - name: state in: query @@ -2101,6 +2102,7 @@ paths: required: true schema: type: string + example: '[FAX_NUMBER]' responses: '200': description: 'successful operation' @@ -8612,6 +8614,10 @@ components: enum: - change-field-visibility - change-group-visibility + x-enum-varnames-override: + csharp: + - FieldVisibility + - GroupVisibility type: object SubFormFieldRuleTrigger: required: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index c2d51ea54..4ad2bd7e1 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -1826,6 +1826,7 @@ paths: - CA - US - UK + example: US - name: state in: query @@ -2107,6 +2108,7 @@ paths: required: true schema: type: string + example: '[FAX_NUMBER]' responses: '200': description: 'successful operation' @@ -8926,6 +8928,10 @@ components: enum: - change-field-visibility - change-group-visibility + x-enum-varnames-override: + csharp: + - FieldVisibility + - GroupVisibility type: object SubFormFieldRuleTrigger: required: diff --git a/openapi.yaml b/openapi.yaml index f6ae63aec..9bb89b7a9 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1826,6 +1826,7 @@ paths: - CA - US - UK + example: US - name: state in: query @@ -2107,6 +2108,7 @@ paths: required: true schema: type: string + example: '[FAX_NUMBER]' responses: '200': description: 'successful operation' @@ -8904,6 +8906,10 @@ components: enum: - change-field-visibility - change-group-visibility + x-enum-varnames-override: + csharp: + - FieldVisibility + - GroupVisibility type: object SubFormFieldRuleTrigger: required: diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj b/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj index 00fa04608..1adb5f2bf 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj @@ -13,6 +13,6 @@ - + From 40d43904ed565697fb0f17743789d7974fa34935 Mon Sep 17 00:00:00 2001 From: Juan Treminio Date: Fri, 13 Dec 2024 12:44:04 -0600 Subject: [PATCH 2/2] Example fixes; enum fixes --- examples/ApiAppUpdate.php | 2 +- examples/ApiAppUpdate.py | 2 +- examples/ApiAppUpdate.rb | 2 +- examples/ApiAppUpdate.sh | 2 +- examples/ApiAppUpdate.ts | 2 +- examples/json/ApiAppCreateResponseExample.json | 2 +- examples/json/ApiAppGetResponseExample.json | 2 +- examples/json/ApiAppListResponseExample.json | 2 +- examples/json/ApiAppUpdateRequestDefaultExample.json | 2 +- examples/json/ApiAppUpdateResponseExample.json | 4 ++-- ...aimedDraftCreateRequestFormFieldGroupsExample.json | 1 + ...laimedDraftCreateRequestFormFieldRulesExample.json | 1 + ...raftCreateRequestFormFieldsPerDocumentExample.json | 1 + openapi-raw.yaml | 11 +++++++++++ openapi-sdk.yaml | 11 +++++++++++ openapi.yaml | 11 +++++++++++ 16 files changed, 47 insertions(+), 11 deletions(-) diff --git a/examples/ApiAppUpdate.php b/examples/ApiAppUpdate.php index 2e96f9e44..60520cccc 100644 --- a/examples/ApiAppUpdate.php +++ b/examples/ApiAppUpdate.php @@ -20,7 +20,7 @@ $data = new Dropbox\Sign\Model\ApiAppUpdateRequest(); $data->setName("New Name") - ->setCallbackUrl("http://example.com/dropboxsign") + ->setCallbackUrl("https://example.com/dropboxsign") ->setWhiteLabelingOptions($whiteLabelingOptions) ->setCustomLogoFile($customLogoFile); diff --git a/examples/ApiAppUpdate.py b/examples/ApiAppUpdate.py index 97ea06561..38f812095 100644 --- a/examples/ApiAppUpdate.py +++ b/examples/ApiAppUpdate.py @@ -21,7 +21,7 @@ data = models.ApiAppUpdateRequest( name="New Name", - callback_url="http://example.com/dropboxsign", + callback_url="https://example.com/dropboxsign", white_labeling_options=white_labeling_options, custom_logo_file=custom_logo_file, ) diff --git a/examples/ApiAppUpdate.rb b/examples/ApiAppUpdate.rb index 44572cfb8..940f70c78 100644 --- a/examples/ApiAppUpdate.rb +++ b/examples/ApiAppUpdate.rb @@ -18,7 +18,7 @@ data = Dropbox::Sign::ApiAppUpdateRequest.new data.name = "New Name" -data.callback_url = "http://example.com/dropboxsign" +data.callback_url = "https://example.com/dropboxsign" data.white_labeling_options = white_labeling_options data.custom_logo_file = custom_logo_file diff --git a/examples/ApiAppUpdate.sh b/examples/ApiAppUpdate.sh index 99a6b5f40..f8e22a9c8 100644 --- a/examples/ApiAppUpdate.sh +++ b/examples/ApiAppUpdate.sh @@ -1,6 +1,6 @@ curl -X PUT 'https://api.hellosign.com/v3/api_app/{client_id}' \ -u 'YOUR_API_KEY:' \ -F 'name=New Name' \ - -F 'callback_url=http://example.com/dropboxsign' \ + -F 'callback_url=https://example.com/dropboxsign' \ -F 'white_labeling_options[primary_button_color]=#00b3e6' \ -F 'white_labeling_options[primary_button_text_color]=#ffffff' diff --git a/examples/ApiAppUpdate.ts b/examples/ApiAppUpdate.ts index fdbc25559..a53f3f1c0 100644 --- a/examples/ApiAppUpdate.ts +++ b/examples/ApiAppUpdate.ts @@ -16,7 +16,7 @@ const whiteLabelingOptions: DropboxSign.SubWhiteLabelingOptions = { const data: DropboxSign.ApiAppUpdateRequest = { name: "New Name", - callbackUrl: "http://example.com/dropboxsign", + callbackUrl: "https://example.com/dropboxsign", customLogoFile: fs.createReadStream("CustomLogoFile.png"), whiteLabelingOptions, }; diff --git a/examples/json/ApiAppCreateResponseExample.json b/examples/json/ApiAppCreateResponseExample.json index 9e92dda05..9e81c9fc0 100644 --- a/examples/json/ApiAppCreateResponseExample.json +++ b/examples/json/ApiAppCreateResponseExample.json @@ -7,7 +7,7 @@ "is_approved": false, "name": "My Production App", "oauth": { - "callback_url": "http://example.com/oauth", + "callback_url": "https://example.com/oauth", "scopes": [ "basic_account_info", "request_signature" diff --git a/examples/json/ApiAppGetResponseExample.json b/examples/json/ApiAppGetResponseExample.json index 6074e44ec..a060d5261 100644 --- a/examples/json/ApiAppGetResponseExample.json +++ b/examples/json/ApiAppGetResponseExample.json @@ -7,7 +7,7 @@ "is_approved": true, "name": "My Production App", "oauth": { - "callback_url": "http://example.com/oauth", + "callback_url": "https://example.com/oauth", "scopes": [ "basic_account_info", "request_signature" diff --git a/examples/json/ApiAppListResponseExample.json b/examples/json/ApiAppListResponseExample.json index 3c358bff5..130766322 100644 --- a/examples/json/ApiAppListResponseExample.json +++ b/examples/json/ApiAppListResponseExample.json @@ -8,7 +8,7 @@ "is_approved": true, "name": "My Production App", "oauth": { - "callback_url": "http://example.com/oauth", + "callback_url": "https://example.com/oauth", "scopes": [ "basic_account_info", "request_signature" diff --git a/examples/json/ApiAppUpdateRequestDefaultExample.json b/examples/json/ApiAppUpdateRequestDefaultExample.json index f7bffb683..7977b977e 100644 --- a/examples/json/ApiAppUpdateRequestDefaultExample.json +++ b/examples/json/ApiAppUpdateRequestDefaultExample.json @@ -1,6 +1,6 @@ { "name": "New Name", - "callback_url": "http://example.com/dropboxsign", + "callback_url": "https://example.com/dropboxsign", "white_labeling_options": { "primary_button_color": "#00b3e6", "primary_button_text_color": "#ffffff" diff --git a/examples/json/ApiAppUpdateResponseExample.json b/examples/json/ApiAppUpdateResponseExample.json index 75c789a12..8b53b27db 100644 --- a/examples/json/ApiAppUpdateResponseExample.json +++ b/examples/json/ApiAppUpdateResponseExample.json @@ -1,13 +1,13 @@ { "api_app": { - "callback_url": "http://example.com/dropboxsign", + "callback_url": "https://example.com/dropboxsign", "client_id": "0dd3b823a682527788c4e40cb7b6f7e9", "created_at": 1436232339, "domains": ["example.com"], "is_approved": false, "name": "New Name", "oauth": { - "callback_url": "http://example.com/oauth", + "callback_url": "https://example.com/oauth", "scopes": [ "basic_account_info", "request_signature" diff --git a/examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json b/examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json index ac48565f0..d8e5db930 100644 --- a/examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json +++ b/examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json @@ -41,5 +41,6 @@ "requirement": "require_0-1" } ], + "type": "request_signature", "test_mode": false } diff --git a/examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json b/examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json index c12700553..8b1fe7d85 100644 --- a/examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json +++ b/examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json @@ -51,5 +51,6 @@ ] } ], + "type": "request_signature", "test_mode": false } diff --git a/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json b/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json index 6ba9c8837..4d9961c57 100644 --- a/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json +++ b/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json @@ -32,5 +32,6 @@ "page": 1 } ], + "type": "request_signature", "test_mode": false } diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 24bcdd147..64d635940 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -7767,6 +7767,11 @@ components: - CA - US - UK + x-enum-varnames-override: + typescript-node: + - Ca + - Us + - Uk city: description: '_t__FaxLineCreate::CITY' type: string @@ -8618,6 +8623,12 @@ components: csharp: - FieldVisibility - GroupVisibility + php: + - TYPE_FIELD_VISIBILITY + - TYPE_GROUP_VISIBILITY + typescript-node: + - FieldVisibility + - GroupVisibility type: object SubFormFieldRuleTrigger: required: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 4ad2bd7e1..818930290 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -7861,6 +7861,11 @@ components: - CA - US - UK + x-enum-varnames-override: + typescript-node: + - Ca + - Us + - Uk city: description: City type: string @@ -8932,6 +8937,12 @@ components: csharp: - FieldVisibility - GroupVisibility + php: + - TYPE_FIELD_VISIBILITY + - TYPE_GROUP_VISIBILITY + typescript-node: + - FieldVisibility + - GroupVisibility type: object SubFormFieldRuleTrigger: required: diff --git a/openapi.yaml b/openapi.yaml index 9bb89b7a9..d0dbb629b 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -7861,6 +7861,11 @@ components: - CA - US - UK + x-enum-varnames-override: + typescript-node: + - Ca + - Us + - Uk city: description: City type: string @@ -8910,6 +8915,12 @@ components: csharp: - FieldVisibility - GroupVisibility + php: + - TYPE_FIELD_VISIBILITY + - TYPE_GROUP_VISIBILITY + typescript-node: + - FieldVisibility + - GroupVisibility type: object SubFormFieldRuleTrigger: required: