Skip to content

Commit c6b5686

Browse files
abnegateabnegate
committed
Fix docs
1 parent 4c28b96 commit c6b5686

File tree

12 files changed

+96
-36
lines changed

12 files changed

+96
-36
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ void main() { // Init SDK
2222

2323
{% endif %}
2424
{% if parameter.required %}
25-
{{ parameter.name | caseCamel | overrideIdentifier }}:{% if parameter.enumValues | length > 0 %} {{ parameter.enumName }}.{{ parameter.enumValues[0] | caseCamel | replace({'-': ''}) }}{% else %}{{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }} {% endif %},
25+
{{ 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 %},
2626
{% endif %}
2727
{% endfor %}{% if method.parameters.all | length > 0 %} {% endif %});
2828

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ client
1919

2020
{% endif %}
2121

22-
let promise = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{% if parameter.enumValues | length > 0%}{{parameter.enumName}}.{{ parameter.enumValues[0] | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% endif %}{% endfor %});
22+
let promise = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{% if parameter.enumValues | length > 0%}{{parameter.enumName}}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% endif %}{% endfor %});
2323

2424
promise.then(function (response) {
2525
console.log(response);

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ var {{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}(client
1818
{% 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 %}
1919
{% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %},{% endif %}
2020

21-
{{ parameter.name }}: {% if parameter.enumValues | length > 0%}{{ parameter.enumName }}.{{ parameter.enumValues[0] | caseEnumKey }}{% else %}{{ parameter | paramExample }}{% endif %}{% endif %}{% endfor %}{% if method.parameters.all | length > 0 %});{% endif %}
21+
{{ parameter.name }}: {% if parameter.enumValues | length > 0%}{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample }}{% endif %}{% endif %}{% endfor %}{% if method.parameters.all | length > 0 %});{% endif %}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ void main() { // Init SDK
2323

2424
{% endif %}
2525
{% if parameter.required %}
26-
{{ parameter.name | caseCamel | overrideIdentifier}}:{% if parameter.enumValues | length > 0%} {{parameter.enumName}}.{{ parameter.enumValues[0] | caseEnumKey }}.value{% else %}{{ parameter | paramExample}} {% endif %},
26+
{{ parameter.name | caseCamel | overrideIdentifier}}:{% if parameter.enumValues | length > 0%} {{parameter.enumName}}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}.value{% else %}{{ parameter | paramExample}} {% endif %},
2727
{% endif %}
2828
{% endfor %}{% if method.parameters.all | length > 0 %} {% endif %}).then((bytes) {
2929
final file = File('path_to_file/filename.ext');
@@ -40,7 +40,7 @@ FutureBuilder(
4040

4141
{% endif %}
4242
{% if parameter.required %}
43-
{{ parameter.name | caseCamel | overrideIdentifier}}:{% if parameter.enumValues | length > 0%} {{parameter.enumName}}.{{ parameter.enumValues[0] | caseEnumKey }}.value{% else %}{{ parameter | paramExample}} {% endif %},
43+
{{ parameter.name | caseCamel | overrideIdentifier}}:{% if parameter.enumValues | length > 0%} {{parameter.enumName}}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}.value{% else %}{{ parameter | paramExample}} {% endif %},
4444
{% endif %}
4545
{% endfor %}{% if method.parameters.all | length > 0 %} {% endif %}
4646
), //works for both public file and private file, for private files you need to be logged in
@@ -58,7 +58,7 @@ FutureBuilder(
5858

5959
{% endif %}
6060
{% if parameter.required %}
61-
{{ parameter.name | caseCamel | overrideIdentifier}}:{% if parameter.enumValues | length > 0%} {{parameter.enumName}}.{{ parameter.enumValues[0] | caseEnumKey }}.value{% else %}{{ parameter | paramExample}} {% endif %},
61+
{{ parameter.name | caseCamel | overrideIdentifier}}:{% if parameter.enumValues | length > 0%} {{parameter.enumName}}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}.value{% else %}{{ parameter | paramExample}} {% endif %},
6262
{% endif %}
6363
{% endfor %}{% if method.parameters.all | length > 0 %} {% endif %});
6464

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

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,22 @@ import {{ sdk.namespace | caseDot }}.coroutines.CoroutineCallback;
44
import {{ sdk.namespace | caseDot }}.models.InputFile;
55
{% endif %}
66
import {{ sdk.namespace | caseDot }}.services.{{ service.name | caseUcfirst }};
7-
{% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}{% endif %}
8-
{% if parameter.enumValues | length > 0%}import {{ sdk.namespace | caseDot }}.enums.{{parameter.enumName | caseUcfirst}};{% endif %}
9-
10-
{% endif %}{% endfor %}
7+
{% set added = [] %}
8+
{% for parameter in method.parameters.all %}
9+
{% if method == parameter.required %}
10+
{% if parameter.enumValues is not empty %}
11+
{% if parameter.enumName is not empty %}
12+
{% set name = parameter.enumName %}
13+
{% else %}
14+
{% set name = parameter.name %}
15+
{% endif %}
16+
{% if name not in added %}
17+
import {{ sdk.namespace | caseDot }}.enums.{{ name | caseUcfirst }};
18+
{% set added = added|merge([name]) %}
19+
{% endif %}
20+
{% endif %}
21+
{% endif %}
22+
{% endfor %}
1123

1224
Client client = new Client()
1325
{% if method.auth|length > 0 %}
@@ -30,7 +42,7 @@ Client client = new Client()
3042

3143
{% for parameter in method.parameters.all %}
3244
{% if parameter.required %}
33-
{% if parameter.enumValues | length > 0%} {{ parameter.enumName }}.{{ parameter.enumValues[0] | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% if not loop.last %},{% endif %}
45+
{% if parameter.enumValues | length > 0%}{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% if not loop.last %},{% endif %}
3446

3547
{% endif %}
3648
{% if loop.last %}

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

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,27 @@
11
import {{ sdk.namespace | caseDot }}.Client
2+
import {{ sdk.namespace | caseDot }}.coroutines.CoroutineCallback
23
{% if method.parameters.all | filter((param) => param.type == 'file') | length > 0 %}
34
import {{ sdk.namespace | caseDot }}.models.InputFile
45
{% endif %}
56
import {{ sdk.namespace | caseDot }}.services.{{ service.name | caseUcfirst }}
6-
{% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}{% endif %}
7-
{% if parameter.enumValues | length > 0%}import {{ sdk.namespace | caseDot }}.enums.{{parameter.enumName | caseUcfirst}}{% endif %}
8-
9-
{% endif %}{% endfor %}
7+
{% set added = [] %}
8+
{% for parameter in method.parameters.all %}
9+
{% if method == parameter.required %}
10+
{% if parameter.enumValues is not empty %}
11+
{% if parameter.enumName is not empty %}
12+
{% set name = parameter.enumName %}
13+
{% else %}
14+
{% set name = parameter.name %}
15+
{% endif %}
16+
{% if name not in added %}
17+
import {{ sdk.namespace | caseDot }}.enums.{{ name | caseUcfirst }}
18+
{% set added = added|merge([name]) %}
19+
{% endif %}
20+
{% endif %}
21+
{% endif %}
22+
{% endfor %}
1023

11-
val client = Client(context)
24+
val client = Client()
1225
{% if method.auth|length > 0 %}
1326
.setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
1427
{% for node in method.auth %}
@@ -22,7 +35,7 @@ val {{ service.name | caseCamel }} = {{ service.name | caseUcfirst }}(client)
2235

2336
{% for parameter in method.parameters.all %}
2437
{% if parameter.required %}
25-
{{parameter.name}} = {% if parameter.enumValues | length > 0 %} {{ parameter.enumName }}.{{ parameter.enumValues[0] | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% if not loop.last %},{% endif %}
38+
{{parameter.name}} = {% if parameter.enumValues | length > 0 %} {{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% if not loop.last %},{% endif %}
2639

2740
{% endif %}
2841
{% if loop.last %}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const fs = require('fs');
66
// Init SDK
77
const client = new sdk.Client();
88

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

1111
{% if method.auth|length > 0 %}
1212
client
@@ -18,7 +18,7 @@ client
1818
{% endfor %};
1919

2020
{% endif %}
21-
const promise = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{% if parameter.enumValues | length > 0%}{{parameter.enumName}}.{{(parameter.enumKeys[0] ?? parameter.enumValues[0]) | replace({'-': '',' ': ''}) }}{% else%}{{ parameter | paramExample}}{% endif %}{% endif %}{% endfor %});
21+
const promise = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{% if parameter.enumValues | length > 0%}sdk.{{ parameter.enumName }}.{{(parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample}}{% endif %}{% endif %}{% endfor %});
2222

2323
promise.then(function (response) {
2424
console.log(response);

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

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,22 @@ use {{ spec.title | caseUcfirst }}\Client;
55
use {{ spec.title | caseUcfirst }}\InputFile;
66
{% endif %}
77
use {{ spec.title | caseUcfirst }}\Services\{{ service.name | caseUcfirst }};
8-
{% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}{% endif %}
9-
{% if parameter.enumValues | length > 0%}use {{ spec.title | caseUcfirst }}\Enums\{{parameter.enumName | caseUcfirst}};{% endif %}
10-
11-
{% endif %}{% endfor %}
8+
{% set added = [] %}
9+
{% for parameter in method.parameters.all %}
10+
{% if method == parameter.required %}
11+
{% if parameter.enumValues is not empty %}
12+
{% if parameter.enumName is not empty %}
13+
{% set name = parameter.enumName %}
14+
{% else %}
15+
{% set name = parameter.name %}
16+
{% endif %}
17+
{% if name not in added %}
18+
use {{ spec.title | caseUcfirst }}\Enums\{{parameter.enumName | caseUcfirst}};
19+
{% set added = added|merge([name]) %}
20+
{% endif %}
21+
{% endif %}
22+
{% endif %}
23+
{% endfor %}
1224
1325
$client = new Client();
1426
@@ -22,6 +34,6 @@ $client
2234
{% endfor %};
2335
2436
{% endif %}
25-
${{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}($client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %});
37+
${{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}($client);
2638
27-
$result = ${{ service.name | caseCamel }}->{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{% if parameter.enumValues | length > 0%}{{ parameter.enumName }}.{{ parameter.enumValues[0] | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% endif %}{% endfor %});
39+
$result = ${{ service.name | caseCamel }}->{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{% if parameter.enumValues | length > 0%}{{ parameter.enumName }}::{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}(){% else%}{{ parameter | paramExample }}{% endif %}{% endif %}{% endfor %});

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

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,22 @@ from {{ spec.title | caseSnake }}.client import Client
22
{% if method.parameters.all | filter((param) => param.type == 'file') | length > 0 %}
33
from {{ spec.title | caseSnake }}.input_file import InputFile
44
{% endif %}
5-
from {{ spec.title | caseSnake }}.services.{{ service.name | caseSnake }} import {{ service.name | caseUcfirst }}
6-
{% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}{% endif %}
7-
{% if parameter.enumValues | length > 0%}from {{ spec.title | caseUcfirst }}.enums import {{parameter.enumName | caseUcfirst}},{% endif %}
8-
{% endif %}{% endfor %}
5+
{% set added = [] %}
6+
{% for parameter in method.parameters.all %}
7+
{% if method == parameter.required %}
8+
{% if parameter.enumValues is not empty %}
9+
{% if parameter.enumName is not empty %}
10+
{% set name = parameter.enumName %}
11+
{% else %}
12+
{% set name = parameter.name %}
13+
{% endif %}
14+
{% if name not in added %}
15+
from {{ spec.title | caseUcfirst }}.enums import {{parameter.enumName | caseUcfirst}}
16+
{% set added = added|merge([name]) %}
17+
{% endif %}
18+
{% endif %}
19+
{% endif %}
20+
{% endfor %}
921

1022
client = Client()
1123

@@ -19,6 +31,6 @@ client = Client()
1931
{% endfor %})
2032

2133
{% endif %}
22-
{{ service.name | caseSnake }} = {{ service.name | caseUcfirst }}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %})
34+
{{ service.name | caseSnake }} = {{ service.name | caseUcfirst }}(client)
2335

24-
result = {{ service.name | caseSnake }}.{{ method.name | caseSnake }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{% if parameter.enumValues | length > 0 %} {{ parameter.enumName }}.{{ parameter.enumValues[0] | caseEnumKey }}{% else %}{{ parameter | paramExample }}{% endif %}{% endif %}{% endfor %})
36+
result = {{ service.name | caseSnake }}.{{ method.name | caseSnake }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{% if parameter.enumValues | length > 0 %}{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample }}{% endif %}{% endif %}{% endfor %})

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

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
require '{{ spec.title }}'
22

33
include {{ spec.title | caseUcfirst }}
4+
{% set break = false %}
5+
{% for parameter in method.parameters.all %}
6+
{% if not break %}
7+
{% if method == parameter.required %}
8+
{% if parameter.enumValues is not empty %}
9+
include {{ spec.title | caseUcfirst }}::Enums
10+
{% set break = true %}
11+
{% endif %}
12+
{% endif %}
13+
{% endif %}
14+
{% endfor %}
415

516
client = Client.new
617
.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
@@ -10,8 +21,8 @@ client = Client.new
1021
{% endfor %}
1122
{% endfor %}
1223

13-
{{ service.name | caseSnake }} = {{ service.name | caseUcfirst }}.new(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{parameter.name | caseSnake}}:{{ parameter | paramExample }}{% endfor %}{% endif %})
24+
{{ service.name | caseSnake }} = {{ service.name | caseUcfirst }}.new(client)
1425

15-
response = {{ service.name | caseSnake }}.{{ method.name | caseSnake }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{parameter.name|caseSnake}}: {% if parameter.type == 'file' %}{{ parameter | paramExample }}{% else %}{{ parameter | paramExample }}{% endif %}{% endif %}{% endfor %})
26+
response = {{ service.name | caseSnake }}.{{ method.name | caseSnake }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{parameter.name|caseSnake}}: {% if parameter.type == 'file' %}{{ parameter | paramExample }}{% else %}{% if parameter.enumValues | length > 0%}{{ parameter.enumName }}::{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample }}{% endif %}{% endif %}{% endif %}{% endfor %})
1627

1728
puts response.inspect

0 commit comments

Comments
 (0)