Skip to content

Commit a38b2b1

Browse files
suchcicki-dropboxsuchcicki-dropbox
committed
[SIGN-15721] Add example URLs to SDK templates
1 parent f00994d commit a38b2b1

6 files changed

Lines changed: 27 additions & 1 deletion

File tree

‎sdks/dotnet/templates/api.mustache‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ namespace {{packageName}}.{{apiPackage}}
3131
/// {{.}}
3232
/// </remarks>
3333
{{/notes}}
34+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs</example>
3435
/// <exception cref="{{packageName}}.Client.ApiException">Thrown when fails to make API call</exception>
3536
{{#allParams}}/// <param name="{{paramName}}">{{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
3637
{{/allParams}}/// <param name="operationIndex">Index associated with the operation.</param>
@@ -46,6 +47,7 @@ namespace {{packageName}}.{{apiPackage}}
4647
/// <remarks>
4748
/// {{notes}}
4849
/// </remarks>
50+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs</example>
4951
/// <exception cref="{{packageName}}.Client.ApiException">Thrown when fails to make API call</exception>
5052
{{#allParams}}/// <param name="{{paramName}}">{{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
5153
{{/allParams}}/// <param name="operationIndex">Index associated with the operation.</param>
@@ -72,6 +74,7 @@ namespace {{packageName}}.{{apiPackage}}
7274
/// <remarks>
7375
/// {{notes}}
7476
/// </remarks>
77+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs</example>
7578
/// <exception cref="{{packageName}}.Client.ApiException">Thrown when fails to make API call</exception>
7679
{{#allParams}}
7780
/// <param name="{{paramName}}">{{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
@@ -90,6 +93,7 @@ namespace {{packageName}}.{{apiPackage}}
9093
/// <remarks>
9194
/// {{notes}}
9295
/// </remarks>
96+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs</example>
9397
/// <exception cref="{{packageName}}.Client.ApiException">Thrown when fails to make API call</exception>
9498
{{#allParams}}
9599
/// <param name="{{paramName}}">{{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
@@ -237,6 +241,7 @@ namespace {{packageName}}.{{apiPackage}}
237241
/// <summary>
238242
/// {{summary}} {{notes}}
239243
/// </summary>
244+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs</example>
240245
/// <exception cref="{{packageName}}.Client.ApiException">Thrown when fails to make API call</exception>
241246
{{#allParams}}/// <param name="{{paramName}}">{{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
242247
{{/allParams}}/// <param name="operationIndex">Index associated with the operation.</param>
@@ -253,6 +258,7 @@ namespace {{packageName}}.{{apiPackage}}
253258
/// <summary>
254259
/// {{summary}} {{notes}}
255260
/// </summary>
261+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs</example>
256262
/// <exception cref="{{packageName}}.Client.ApiException">Thrown when fails to make API call</exception>
257263
{{#allParams}}/// <param name="{{paramName}}">{{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
258264
{{/allParams}}/// <param name="operationIndex">Index associated with the operation.</param>
@@ -533,6 +539,7 @@ namespace {{packageName}}.{{apiPackage}}
533539
/// <summary>
534540
/// {{summary}} {{notes}}
535541
/// </summary>
542+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs</example>
536543
/// <exception cref="{{packageName}}.Client.ApiException">Thrown when fails to make API call</exception>
537544
{{#allParams}}
538545
/// <param name="{{paramName}}">{{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
@@ -552,6 +559,7 @@ namespace {{packageName}}.{{apiPackage}}
552559
/// <summary>
553560
/// {{summary}} {{notes}}
554561
/// </summary>
562+
/// <example>https://github.com/hellosign/dropbox-sign-dotnet/blob/main/examples/{{operationIdCamelCase}}Example.cs</example>
555563
/// <exception cref="{{packageName}}.Client.ApiException">Thrown when fails to make API call</exception>
556564
{{#allParams}}
557565
/// <param name="{{paramName}}">{{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>

‎sdks/java-v2/templates/libraries/jersey3/api.mustache‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ public class {{classname}} {
5858
/**
5959
* {{summary}}
6060
* {{notes}}
61+
* Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java
6162
{{#allParams}}
6263
* @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
6364
{{/allParams}}
@@ -99,6 +100,7 @@ public class {{classname}} {
99100
/**
100101
* {{summary}}
101102
* {{notes}}
103+
* Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java
102104
{{#allParams}}
103105
* @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
104106
{{/allParams}}
@@ -269,6 +271,7 @@ public class {{classname}} {
269271

270272
/**
271273
* Execute {{operationId}} request
274+
* Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java
272275
{{#returnType}}* @return {{.}}{{/returnType}}
273276
* @throws ApiException if fails to make API call
274277
{{#responses.0}}
@@ -290,6 +293,7 @@ public class {{classname}} {
290293

291294
/**
292295
* Execute {{operationId}} request with HTTP info returned
296+
* Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java
293297
* @return ApiResponse&lt;{{returnType}}{{^returnType}}Void{{/returnType}}&gt;
294298
* @throws ApiException if fails to make API call
295299
{{#responses.0}}
@@ -316,6 +320,7 @@ public class {{classname}} {
316320
/**
317321
* {{summary}}
318322
* {{notes}}{{#pathParams}}
323+
* Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java
319324
* @param {{paramName}} {{description}} (required){{/pathParams}}
320325
* @return {{operationId}}Request
321326
* @throws ApiException if fails to make API call

‎sdks/node/templates/api-single.mustache‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,7 @@ export class {{classname}} {
198198
{{#summary}}
199199
* @summary {{&summary}}
200200
{{/summary}}
201+
* Example: https://github.com/hellosign/dropbox-sign-node/blob/main/examples/{{operationIdCamelCase}}Example.ts
201202
{{#allParams}}
202203
* @param {{paramName}} {{description}}
203204
{{/allParams}}

‎sdks/php/templates/api.mustache‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,8 @@ use Psr\Http\Message\ResponseInterface;
171171
* {{.}}
172172
*
173173
{{/description}}
174+
* Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/{{operationIdCamelCase}}Example.php
175+
*
174176
{{#vendorExtensions.x-group-parameters}}
175177
* Note: the input parameter is an associative array with the keys listed as the parameter name below
176178
*
@@ -240,6 +242,8 @@ use Psr\Http\Message\ResponseInterface;
240242
* {{.}}
241243
*
242244
{{/description}}
245+
* Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/{{operationIdCamelCase}}Example.php
246+
*
243247
{{#vendorExtensions.x-group-parameters}}
244248
* Note: the input parameter is an associative array with the keys listed as the parameter name below
245249
*
@@ -448,6 +452,8 @@ use Psr\Http\Message\ResponseInterface;
448452
* {{.}}
449453
*
450454
{{/description}}
455+
* Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/{{operationIdCamelCase}}Example.php
456+
*
451457
{{#vendorExtensions.x-group-parameters}}
452458
* Note: the input parameter is an associative array with the keys listed as the parameter name below
453459
*
@@ -513,6 +519,8 @@ use Psr\Http\Message\ResponseInterface;
513519
* {{.}}
514520
*
515521
{{/description}}
522+
* Example: https://github.com/hellosign/dropbox-sign-php/blob/main/examples/{{operationIdCamelCase}}Example.php
523+
*
516524
{{#vendorExtensions.x-group-parameters}}
517525
* Note: the input parameter is an associative array with the keys listed as the parameter name below
518526
*

‎sdks/python/templates/partial_api.mustache‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
{{{.}}}
55
{{/notes}}
66

7+
Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/{{operationIdCamelCase}}Example.py
8+
79
{{#allParams}}
810
:param {{paramName}}:{{#description}} {{{.}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional){{/optional}}
911
:type {{paramName}}: {{dataType}}{{#optional}}, optional{{/optional}}
@@ -49,4 +51,4 @@
4951
'{{code}}': {{#dataType}}"{{.}}"{{/dataType}}{{^dataType}}None{{/dataType}},
5052
{{/isWildcard}}
5153
{{/responses}}
52-
}
54+
}

‎sdks/ruby/templates/api.mustache‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ module {{moduleName}}
2424
{{#notes}}
2525
# {{{.}}}
2626
{{/notes}}
27+
# Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/{{operationIdCamelCase}}Example.rb
2728
{{#vendorExtensions.x-group-parameters}}
2829
# @param [Hash] opts the parameters
2930
{{#allParams}}
@@ -57,6 +58,7 @@ module {{moduleName}}
5758
{{#notes}}
5859
# {{.}}
5960
{{/notes}}
61+
# Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/{{operationIdCamelCase}}Example.rb
6062
{{#vendorExtensions.x-group-parameters}}
6163
# @param [Hash] opts the parameters
6264
{{#allParams}}

0 commit comments

Comments
 (0)