Skip to content

Commit b961010

Browse files
abnegateabnegate
committed
Fix examples
1 parent 38119c7 commit b961010

File tree

8 files changed

+52
-73
lines changed

8 files changed

+52
-73
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ val client = Client(context)
3434
val {{ service.name | caseCamel }} = {{ service.name | caseUcfirst }}(client)
3535

3636
{% if method.type == 'webAuth' %}
37-
{% elseif method.type == 'location' %}
38-
val result = {%~ else %}val response = {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %}){% endif %}
37+
{% else %}
38+
val result = {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %}){% endif %}
3939

4040
{%~ for parameter in method.parameters.all %}
4141
{%~ if parameter.enumValues is not empty -%}

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

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,22 @@ import 'dart:io';
44
import 'package:{{ language.params.packageName }}/{{ language.params.packageName }}.dart';
55

66
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 %}
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 %}
1515

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

18-
Future result = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});{% endif %}
18+
{% if method.method != 'delete' and method.type != 'webAuth' %}{% if method.type == 'location' %}UInt8List{% else %}{{ method.responseModel | caseUcfirst | overrideIdentifier }}{% endif %} result = {% endif %}await {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});{% endif %}
1919

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 %}
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 %}
2222

23-
{%~ endfor %}
23+
{%~ endfor %}
2424
{% if method.parameters.all | length > 0 %});
25-
{% endif %}
26-
27-
result.then((response) {
28-
print(response);
29-
}).catchError((error) {
30-
print(error.response);
31-
});
25+
{% endif %}

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,4 @@ const {{ service.name | caseCamel }} = new {{service.name | caseUcfirst}}(client
2020

2121
{%~ endfor %}
2222
{% if method.parameters.all | length > 0 %});
23-
{% endif %}
24-
25-
{% if method.type != 'webAuth' %}
26-
console.log({% if method.type == 'location' %}result{% else %}response{% endif %});
2723
{% endif %}

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
using {{ spec.title | caseUcfirst }};
2-
using {{ spec.title | caseUcfirst }}.Services;
3-
using {{ spec.title | caseUcfirst }}.Models;
4-
{% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}{% endif %}
2+
{% for parameter in method.parameters.all %}
3+
{% if parameter.enumValues | length > 0 %}
54
using {{ spec.title | caseUcfirst }}.Enums;
6-
{% endif %}{% endfor %}
5+
{% endif %}
6+
{% endfor %}
7+
using {{ spec.title | caseUcfirst }}.Models;
8+
using {{ spec.title | caseUcfirst }}.Services;
79

810
Client client = new Client()
911
{% if method.auth|length > 0 %}

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

Lines changed: 28 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,60 +4,49 @@ import 'dart:io';
44
import 'package:{{ language.params.packageName }}/{{ language.params.packageName }}.dart';
55

66
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 %}
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 %}
1515

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

1818
{% if method.type == 'location' %}
1919
// 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 %}
20+
UInt8List bytes = await {{ 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-
{%~ 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-
})
24+
{%~ endfor %}{% if method.parameters.all | length > 0 %}{% endif %})
25+
26+
final file = File('path_to_file/filename.ext');
27+
file.writeAsBytesSync(bytes);
3028

3129
// Displaying image preview
3230
FutureBuilder(
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 %}
31+
future: {{ service.name | caseCamel }}.{{ method.name | caseCamel }}(
32+
{%~ for parameter in method.parameters.all %}
33+
{{ 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 %}
3634

37-
{%~ endfor %}
35+
{%~ endfor %}
3836
), // Works for both public file and private file, for private files you need to be logged in
39-
builder: (context, snapshot) {
40-
return snapshot.hasData && snapshot.data != null
41-
? Image.memory(
42-
snapshot.data,
43-
)
44-
: CircularProgressIndicator();
45-
}
37+
builder: (context, snapshot) {
38+
return snapshot.hasData && snapshot.data != null
39+
? Image.memory(snapshot.data)
40+
: CircularProgressIndicator();
41+
}
4642
);
4743
{% else %}
48-
Future result = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});{% endif %}
44+
{% if method.method != 'delete' and method.type != 'webAuth' %}{% if method.type == 'location' %}UInt8List{% else %}{{ method.responseModel | caseUcfirst | overrideIdentifier }}{% endif %} result = {% endif %}await {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});{% endif %}
4945

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 %}
46+
{%~ for parameter in method.parameters.all %}
47+
{{ 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 %}
5248

53-
{%~ endfor %}
49+
{%~ endfor %}
5450
{% if method.parameters.all | length > 0 %});
5551
{% endif %}
56-
57-
result.then((response) {
58-
print(response);
59-
}).catchError((error) {
60-
print(error.response);
61-
});
62-
6352
{% endif %}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const client = new sdk.Client()
1515

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

18-
const response = await {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});{% endif %}
18+
const result = await {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});{% endif %}
1919

2020
{%~ for parameter in method.parameters.all %}
2121
{% 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 %}

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,11 @@ client = Client.new
2323

2424
{{ service.name | caseSnake }} = {{ service.name | caseUcfirst }}.new(client)
2525

26-
response = {{ service.name | caseSnake }}.{{ method.name | caseSnake }}({% if method.parameters.all | length == 0 %}){% endif %}
26+
result = {{ service.name | caseSnake }}.{{ method.name | caseSnake }}({% if method.parameters.all | length == 0 %}){% endif %}
2727

2828
{%~ for parameter in method.parameters.all %}
2929
{{ parameter.name | caseSnake }}: {% if parameter.enumValues | length > 0%}{{ parameter.enumName }}::{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample }}{% endif %}{% if not loop.last %},{% endif %}{% if not parameter.required %} # optional{% endif %}
3030

3131
{%~ endfor -%}
3232
{% if method.parameters.all | length > 0 %})
3333
{% endif %}
34-
35-
puts response.inspect

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import Appwrite
2-
{% for parameter in method.parameters.all | filter((parameter) => parameter.required) %}
2+
{% for parameter in method.parameters.all %}
33
{% if parameter.enumValues | length > 0 %}
44
import AppwriteEnums
55
{% endif %}

0 commit comments

Comments
 (0)