Skip to content

Commit 5604692

Browse files
abnegateabnegate
committed
Fix examples
1 parent 349a9ce commit 5604692

File tree

14 files changed

+190
-199
lines changed

14 files changed

+190
-199
lines changed

‎src/SDK/Language/DotNet.php

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,11 @@ public function getParamExample(array $param): string
256256
if (\str_ends_with($example, ']')) {
257257
$example = \substr($example, 0, -1);
258258
}
259-
$output .= 'new List<' . $this->getTypeName($param['array']) . '> {' . $example . '}';
259+
if (!empty($example)) {
260+
$output .= 'new List<' . $this->getTypeName($param['array']) . '>() {' . $example . '}';
261+
} else {
262+
$output .= 'new List<' . $this->getTypeName($param['array']) . '>()';
263+
}
260264
break;
261265
}
262266
} else {

‎templates/android/docs/java/example.md.twig

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Client client = new Client(context)
3939
return;
4040
}
4141

42-
Log.d("Appwrite", result.toString());
42+
Log.d("{{ spec.title | caseUcfirst }}", result.toString());
4343
}));{% endif %}
4444

4545
{% for parameter in method.parameters.all %}
@@ -52,16 +52,18 @@ Client client = new Client(context)
5252
{{ name }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}, // {{ parameter.name }} {% if not parameter.required %}(optional){% endif %}
5353
{%~ else %}
5454
{{ parameter | paramExample }}, // {{ parameter.name }} {% if not parameter.required %}(optional){% endif %}
55-
{%~ endif -%}
55+
{%~ endif %}
5656
{%~ if loop.last %}
57+
5758
new CoroutineCallback<>((result, error) -> {
5859
if (error != null) {
5960
error.printStackTrace();
6061
return;
6162
}
6263

63-
Log.d("Appwrite", result.toString());
64+
Log.d("{{ spec.title | caseUcfirst }}", result.toString());
6465
})
6566
);
66-
{%- endif %}
67+
{% endif %}
68+
6769
{% endfor %}

‎templates/android/docs/kotlin/example.md.twig

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ val {{ service.name | caseCamel }} = {{ service.name | caseUcfirst }}(client)
3636
{% if method.type == 'webAuth' %}
3737
{% elseif method.type == 'location' %}
3838
val result = {%~ else %}val response = {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %}){% endif %}
39+
3940
{%~ for parameter in method.parameters.all %}
4041
{%~ if parameter.enumValues is not empty -%}
4142
{%~ if parameter.enumName is not empty -%}
@@ -46,6 +47,7 @@ val result = {%~ else %}val response = {% endif %}{{ service.name | caseCamel }}
4647
{{ parameter.name }} = {{ name }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }},{% if not parameter.required %} // (optional){% endif %}
4748
{%~ else %}
4849
{{ parameter.name }} = {{ parameter | paramExample }}, {% if not parameter.required %}// (optional){% endif %}
49-
{%~ endif -%}
50-
)
51-
{% endfor %}
50+
{%~ endif %}
51+
52+
{%~ endfor %}
53+
{% if method.parameters.all | length > 0 %}){% endif %}

‎templates/dart/docs/example.md.twig

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,29 @@ import 'dart:io';
33
{% endif %}
44
import 'package:{{ language.params.packageName }}/{{ language.params.packageName }}.dart';
55

6-
void main() { // Init SDK
7-
Client client = Client();
8-
{{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = {{service.name | caseUcfirst}}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample }}{% endfor %}{% endif %});
6+
Client client = Client()
7+
{%~ if method.auth|length > 0 %}
8+
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
9+
{%~ for node in method.auth %}
10+
{%~ for key,header in node|keys %}
11+
.set{{header}}('{{node[header]['x-appwrite']['demo']}}'){% if loop.last %};{% endif%} // {{node[header].description}}
12+
{%~ endfor %}
13+
{%~ endfor %}
14+
{%~ endif %}
915

10-
{% if method.auth|length > 0 %}
11-
client
12-
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
13-
{% for node in method.auth %}
14-
{% for key,header in node|keys %}
15-
.set{{header}}('{{node[header]['x-appwrite']['demo']}}') // {{node[header].description}}
16-
{% endfor %}
17-
{% endfor %} ;
16+
{{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = {{service.name | caseUcfirst}}(client);
1817

18+
Future result = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});{% endif %}
19+
20+
{%~ for parameter in method.parameters.all %}
21+
{{ parameter.name | caseCamel | overrideIdentifier }}:{% if parameter.enumValues | length > 0 %} {{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseCamel | replace({'-': ''}) }}{% else %}{{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }} {% endif %},{% if not parameter.required %} // (optional){% endif %}
22+
23+
{%~ endfor %}
24+
{% if method.parameters.all | length > 0 %});
1925
{% endif %}
20-
Future result = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}(
21-
{%~ for parameter in method.parameters.all %}
22-
{{ parameter.name | caseCamel | overrideIdentifier }}:{% if parameter.enumValues | length > 0 %} {{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseCamel | replace({'-': ''}) }}{% else %}{{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }} {% endif %},{% if not parameter.required %} // optional{% endif %}
23-
{%~ endfor %}
24-
);
2526

26-
result
27-
.then((response) {
28-
print(response);
29-
}).catchError((error) {
30-
print(error.response);
31-
});
32-
}}
27+
result.then((response) {
28+
print(response);
29+
}).catchError((error) {
30+
print(error.response);
31+
});

‎templates/deno/docs/example.md.twig

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,31 @@
1-
import * as sdk from "https://deno.land/x/{{ spec.title | caseDash }}/mod.ts";
2-
{# {% if method.consumes[0] == 'multipart/form-data' %}
3-
const fs = require('fs');
4-
{% endif %} #}
1+
import { Client, {{ service.name | caseUcfirst }}{% for parameter in method.parameters.all %}{% if parameter.enumValues | length > 0%}, {{ parameter.enumName | caseUcfirst}}{% endif %}{% endfor %} } from "https://deno.land/x/{{ spec.title | caseDash }}/mod.ts";
52

6-
// Init SDK
7-
let client = new sdk.Client();
3+
const client = new Client()
4+
{%~ if method.auth|length > 0 %}
5+
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
6+
{%~ for node in method.auth %}
7+
{%~ for key,header in node|keys %}
8+
.set{{header}}('{{node[header]['x-appwrite']['demo']}}'){% if loop.last %};{% endif%} // {{node[header].description}}
9+
{%~ endfor %}
10+
{%~ endfor %}
11+
{%~ endif %}
812

9-
let {{ service.name | caseCamel }} = new sdk.{{service.name | caseUcfirst}}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %});
13+
const {{ service.name | caseCamel }} = new {{service.name | caseUcfirst}}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %});
1014

11-
{% if method.auth|length > 0 %}
12-
client
13-
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
14-
{% for node in method.auth %}
15-
{% for key,header in node|keys %}
16-
.set{{header}}('{{node[header]['x-appwrite']['demo']}}') // {{node[header].description}}
17-
{% endfor %}
18-
{% endfor %};
19-
{% endif %}
15+
{% if method.type == 'location' %}
16+
const result =
17+
{% elseif method.type != 'webAuth' %}
18+
const response = await
19+
{% endif -%}
20+
{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});{% endif %}
2021

21-
const promise = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}(
22-
{%~ for parameter in method.parameters.all %}
23-
{%~ if parameter.enumValues | length > 0%}
24-
{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% if not loop.last %}, {% endif %} // {{parameter.name}} {% if not parameter.required %}(optional){% endif %}
25-
{%~ else %}
26-
{{ parameter | paramExample }}{% if not loop.last %}, {% endif %} // {{parameter.name}} {% if not parameter.required %}(optional){% endif %}
27-
{%~ endif %}
28-
{%~ endif %}
29-
{%~ endfor %}
30-
);
22+
{%~ for parameter in method.parameters.all %}
23+
{% if parameter.enumValues | length > 0 %}{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% if not loop.last %},{% endif %} // {{ parameter.name }}{% if not parameter.required %} (optional){% endif %}
24+
25+
{%~ endfor %}
26+
{% if method.parameters.all | length > 0 %});
27+
{% endif %}
3128

32-
promise.then(function (response) {
33-
console.log(response);
34-
}, function (error) {
35-
console.log(error);
36-
});
29+
{% if method.type != 'webAuth' %}
30+
console.log({% if method.type == 'location' %}result{% else %}response{% endif %});
31+
{% endif %}

‎templates/dotnet/docs/example.md.twig

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ var client = new Client()
1515

1616
var {{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}(client);
1717

18-
{% if method.method != 'delete' %}{% if method.type == 'location' %}byte[]{% else %}{{ method.responseModel | caseUcfirst | overrideIdentifier }}{% endif %} result = {% endif %}await {{ service.name | caseCamel }}.{{ method.name | caseUcfirst }}({% if method.parameters.all | length == 0 %});{% endif %}
19-
{%~ for parameter in method.parameters.all -%}
20-
{{ parameter.name }}: {% if parameter.enumValues | length > 0%}{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample }}{% endif %}{% endif %}{% endfor %}{% if not loop.last %},{% if not parameter.required %} // (optional){% endif %}{% else %});{% endif %}
18+
{% if method.method != 'delete' and method.type != 'webAuth' %}{% if method.type == 'location' %}byte[]{% else %}{{ method.responseModel | caseUcfirst | overrideIdentifier }}{% endif %} result = {% endif %}await {{ service.name | caseCamel }}.{{ method.name | caseUcfirst }}({% if method.parameters.all | length == 0 %});{% endif %}
19+
{%~ for parameter in method.parameters.all %}
20+
21+
{{ parameter.name }}: {% if parameter.enumValues | length > 0%}{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample }}{% endif %}{% if not loop.last %},{% if not parameter.required %} // optional{% endif %}{% else %}{% if method.parameters.all | length > 0 %});{% endif %}{% endif %}
22+
{%~ endfor -%}

‎templates/flutter/docs/example.md.twig

Lines changed: 40 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -3,68 +3,61 @@ import 'dart:io';
33
{% endif %}
44
import 'package:{{ language.params.packageName }}/{{ language.params.packageName }}.dart';
55

6-
void main() { // Init SDK
7-
Client client = Client();
8-
{{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = {{service.name | caseUcfirst}}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample }}{% endfor %}{% endif %});
6+
Client client = Client()
7+
{%~ if method.auth|length > 0 %}
8+
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
9+
{%~ for node in method.auth %}
10+
{%~ for key,header in node|keys %}
11+
.set{{header}}('{{node[header]['x-appwrite']['demo']}}'){% if loop.last %};{% endif%} // {{node[header].description}}
12+
{%~ endfor %}
13+
{%~ endfor %}
14+
{%~ endif %}
15+
16+
{{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = {{service.name | caseUcfirst}}(client);
917

10-
{% if method.auth|length > 0 %}
11-
client
12-
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
13-
{% for node in method.auth %}
14-
{% for key,header in node|keys %}
15-
.set{{header}}('{{node[header]['x-appwrite']['demo']}}') // {{node[header].description}}
16-
{% endfor %}
17-
{% endfor %} ;
18-
{% endif %}
1918
{% if method.type == 'location' %}
20-
// downloading file
21-
Future result = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}
22-
{% if loop.first %}
19+
// Downloading file
20+
Future result = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}(
21+
{%~ for parameter in method.parameters.all %}
22+
{{ parameter.name | caseCamel | overrideIdentifier}}:{% if parameter.enumValues | length > 0%} {{parameter.enumName}}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }}{% endif %},{% if not parameter.required %} // (optional){% endif %}
2323

24-
{% endif %}
25-
{{ parameter.name | caseCamel | overrideIdentifier}}:{% if parameter.enumValues | length > 0%} {{parameter.enumName}}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }} {% endif %},{% if not parameter.required %} // optional{% endif %}
26-
{% endfor %}{% if method.parameters.all | length > 0 %} {% endif %}).then((bytes) {
27-
final file = File('path_to_file/filename.ext');
28-
file.writeAsBytesSync(bytes)
29-
}).catchError((error) {
30-
print(error.response);
31-
})
32-
}
24+
{%~ endfor %}{% if method.parameters.all | length > 0 %}{% endif %}).then((bytes) {
25+
final file = File('path_to_file/filename.ext');
26+
file.writeAsBytesSync(bytes)
27+
}).catchError((error) {
28+
print(error.response);
29+
})
3330

34-
//displaying image preview
31+
// Displaying image preview
3532
FutureBuilder(
36-
future: {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}
37-
{% if loop.first %}
33+
future: {{ service.name | caseCamel }}.{{ method.name | caseCamel }}(
34+
{%~ for parameter in method.parameters.all %}
35+
{{ parameter.name | caseCamel | overrideIdentifier}}:{% if parameter.enumValues | length > 0%} {{parameter.enumName}}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}.value{% else %}{{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }} {% endif %},{% if not parameter.required %} // (optional){% endif %}
3836

39-
{% endif %}
40-
{% if parameter.required %}
41-
{{ parameter.name | caseCamel | overrideIdentifier}}:{% if parameter.enumValues | length > 0%} {{parameter.enumName}}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}.value{% else %}{{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }} {% endif %},{% if not parameter.required %} // optional{% endif %}
42-
{% endif %}
43-
{% endfor %}{% if method.parameters.all | length > 0 %} {% endif %}
44-
), //works for both public file and private file, for private files you need to be logged in
37+
{%~ endfor %}
38+
), // Works for both public file and private file, for private files you need to be logged in
4539
builder: (context, snapshot) {
4640
return snapshot.hasData && snapshot.data != null
4741
? Image.memory(
4842
snapshot.data,
4943
)
5044
: CircularProgressIndicator();
51-
},
45+
}
5246
);
5347
{% else %}
54-
Future result = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}
55-
{% if loop.first %}
48+
Future result = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});{% endif %}
5649

50+
{%~ for parameter in method.parameters.all %}
51+
{{ parameter.name | caseCamel | overrideIdentifier}}:{% if parameter.enumValues | length > 0%} {{parameter.enumName}}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }} {% endif %},{% if not parameter.required %} // (optional){% endif %}
52+
53+
{%~ endfor %}
54+
{% if method.parameters.all | length > 0 %});
5755
{% endif %}
58-
{% if parameter.required %}
59-
{{ parameter.name | caseCamel | overrideIdentifier}}:{% if parameter.enumValues | length > 0%} {{parameter.enumName}}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}.value{% else %}{{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }} {% endif %},{% if not parameter.required %} // optional{% endif %}
60-
{% endif %}
61-
{% endfor %}{% if method.parameters.all | length > 0 %} {% endif %});
6256

63-
result
64-
.then((response) {
65-
print(response);
66-
}).catchError((error) {
67-
print(error.response);
68-
});
69-
}
57+
result.then((response) {
58+
print(response);
59+
}).catchError((error) {
60+
print(error.response);
61+
});
62+
7063
{% endif %}

‎templates/kotlin/docs/java/example.md.twig

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,10 @@ Client client = new Client()
4040
System.out.println(result);
4141
}));{% endif %}
4242

43-
{% for parameter in method.parameters.all %}
44-
{% if parameter.enumValues | length > 0%}{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% if not loop.last %}, // {{ parameter.name }}{% if not parameter.required %} (optional){% endif %}{% endif %}
43+
{%~ for parameter in method.parameters.all %}
44+
{% if parameter.enumValues | length > 0%}{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample }}{% endif %}, // {{ parameter.name }}{% if not parameter.required %} (optional){% endif %}
45+
{%~ if loop.last %}
4546

46-
{% endif %}
47-
{% if loop.last %}
4847
new CoroutineCallback<>((result, error) -> {
4948
if (error != null) {
5049
error.printStackTrace();
@@ -55,4 +54,5 @@ Client client = new Client()
5554
})
5655
);
5756
{% endif %}
57+
5858
{% endfor %}

‎templates/node/docs/example.md.twig

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,23 @@ const sdk = require('node-{{ spec.title | caseDash }}');
33
const fs = require('fs');
44
{% endif %}
55

6-
// Init SDK
7-
const client = new sdk.Client();
6+
const client = new sdk.Client()
7+
{%~ if method.auth|length > 0 %}
8+
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
9+
{%~ for node in method.auth %}
10+
{%~ for key,header in node|keys %}
11+
.set{{header}}('{{node[header]['x-appwrite']['demo']}}'){% if loop.last %};{% endif%} // {{node[header].description}}
12+
{%~ endfor %}
13+
{%~ endfor %}
14+
{%~ endif %}
815

916
const {{ service.name | caseCamel }} = new sdk.{{service.name | caseUcfirst}}(client);
1017

11-
{% if method.auth|length > 0 %}
12-
client
13-
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
14-
{% for node in method.auth %}
15-
{% for key,header in node|keys %}
16-
.set{{header}}('{{node[header]['x-appwrite']['demo']}}') // {{node[header].description}}
17-
{% endfor %}
18-
{% endfor %};
18+
const response = await {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});{% endif %}
1919

20-
{% endif %}
21-
const promise = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}(
22-
{%~ for parameter in method.parameters.all -%}
23-
{% if parameter.enumValues | length > 0%}sdk.{{ parameter.enumName }}.{{(parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample}}{% endif %}{% if not loop.last %}, // {{ parameter.name }}{% if not parameter.required %} (optional){% endif %}
24-
{%~ endfor -%}
25-
);
20+
{%~ for parameter in method.parameters.all %}
21+
{% if parameter.enumValues | length > 0%}sdk.{{ parameter.enumName }}.{{(parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample}}{% endif %}{% if not loop.last %},{% endif%} // {{ parameter.name }}{% if not parameter.required %} (optional){% endif %}
2622

27-
promise.then(function (response) {
28-
console.log(response);
29-
}, function (error) {
30-
console.log(error);
31-
});
23+
{%~ endfor -%}
24+
{% if method.parameters.all | length > 0 %});
25+
{% endif %}

0 commit comments

Comments
 (0)