Skip to content

Commit 8d93209

Browse files
eldadfuxeldadfux
authored
Merge pull request #770 from appwrite/show-optional-params
Show all optional params with comment
2 parents a060aac + 4ac831f commit 8d93209

File tree

15 files changed

+85
-23
lines changed

15 files changed

+85
-23
lines changed

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ Client client = new Client(context)
2626

2727
{% for parameter in method.parameters.all %}
2828
{% if parameter.required %}
29-
{{ parameter | paramExample }}{% if not loop.last %},{% endif %}
29+
{{ parameter | paramExample }}{% if not loop.last %},{% endif %} // {{parameter.name}}
3030

31+
{% else %}
32+
{{ parameter | paramExample }}{% if not loop.last %},{% endif %} // {{parameter.name}} (optional)
3133
{% endif %}
3234
{% if loop.last %}
3335
new CoroutineCallback<>((result, error) -> {

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ val {{ service.name | caseCamel }} = {{ service.name | caseUcfirst }}(client)
2020
{% if parameter.required %}
2121
{{parameter.name}} = {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
2222

23+
{% else %}
24+
{{parameter.name}} = {{ parameter | paramExample }}{% if not loop.last %},{% endif %} // optional
2325
{% endif %}
2426
{% if loop.last %}
2527
)

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ void main() { // Init SDK
2323
{% endif %}
2424
{% if parameter.required %}
2525
{{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }},
26+
{% else %}
27+
{{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }}, // optional
2628
{% endif %}
2729
{% endfor %}{% if method.parameters.all | length > 0 %} {% endif %});
2830

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,17 @@ client
1616
.set{{header}}('{{node[header]['x-appwrite']['demo']}}') // {{node[header].description}}
1717
{% endfor %}
1818
{% endfor %};
19-
2019
{% endif %}
2120

22-
let promise = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{ parameter | paramExample }}{% endif %}{% endfor %});
21+
const promise = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}
22+
{% if loop.first %}
23+
24+
{% endif %}{% if parameter.required %}
25+
{{ parameter | paramExample }}{% if not loop.last %}, {% endif %} // {{parameter.name}}
26+
27+
{% else %}
28+
{{ parameter | paramExample }}{% if not loop.last %}, {% endif %} // {{parameter.name}} (optional)
29+
{% endif %}{% endfor %});
2330

2431
promise.then(function (response) {
2532
console.log(response);

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

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

18-
{{ parameter.name }}: {{ parameter | paramExample }}{% endif %}{% endfor %}{% if method.parameters.all | length > 0 %});{% endif %}
18+
{{ parameter.name }}: {{ parameter | paramExample }}{% if loop.last | length > 0 %});{% endif %}{% else %}
19+
20+
{{ parameter.name }}: {{ parameter | paramExample }}{% if loop.last | length > 0 %});{% endif %} // optional{% endif %}{% endfor %}

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

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

2424
{% endif %}
2525
{% if parameter.required %}
26-
{{ parameter.name | caseCamel }}: {{ parameter | paramExample }},
26+
{{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }},
27+
{% else %}
28+
{{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }}, // optional
2729
{% endif %}
2830
{% endfor %}{% if method.parameters.all | length > 0 %} {% endif %}).then((bytes) {
2931
final file = File('path_to_file/filename.ext');
@@ -40,7 +42,9 @@ FutureBuilder(
4042

4143
{% endif %}
4244
{% if parameter.required %}
43-
{{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample }},
45+
{{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }},
46+
{% else %}
47+
{{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }}, // optional
4448
{% endif %}
4549
{% endfor %}{% if method.parameters.all | length > 0 %} {% endif %}
4650
), //works for both public file and private file, for private files you need to be logged in
@@ -58,7 +62,9 @@ FutureBuilder(
5862

5963
{% endif %}
6064
{% if parameter.required %}
61-
{{ parameter.name | caseCamel }}: {{ parameter | paramExample }},
65+
{{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }},
66+
{% else %}
67+
{{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }}, // optional
6268
{% endif %}
6369
{% endfor %}{% if method.parameters.all | length > 0 %} {% endif %});
6470

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{% macro getProperty(definitions, responseModel, depth) %}
22
{%~ for definition in definitions %}
33
{%~ if definition.name == responseModel %}
4-
{%~ for property in definition.properties | filter(p => p.required) %}
4+
{%~ for property in definition.properties %}
55
{{ ("% " ~ depth * 4 ~ "s") |format("") }}{{ property.name | replace({'$': '_'}) }}{%~ if property.sub_schema %} {{ '{' }}
66
{{- '\n' -}}
77
{{- _self.getProperty(definitions, property.sub_schema, depth + 1) -}}
@@ -37,16 +37,16 @@ Content-Length: *Length of your entity body in bytes*
3737
--{{boundary}}
3838
Content-Disposition: form-data; name="operations"
3939

40-
{ "query": "mutation { {{ service.name | caseCamel }}{{ method.name | caseCamel | caseUcfirst }}({% for parameter in method.parameters.all | filter(p => p.required) %}{{ parameter.name | caseCamel }}: ${{ parameter.name | caseCamel }}{% if not loop.last %}, {% endif %}{% endfor %}) { id }" }, "variables": { {% for parameter in method.parameters.all | filter(p => p.required) %}"{{ parameter.name | caseCamel }}": {{ parameter | paramExample }}{% if not loop.last %}, {% endif %}{% endfor %} } }
40+
{ "query": "mutation { {{ service.name | caseCamel }}{{ method.name | caseCamel | caseUcfirst }}({% for parameter in method.parameters.all %}{{ parameter.name | caseCamel }}: ${{ parameter.name | caseCamel }}{% if not loop.last %}, {% endif %}{% endfor %}) { id }" }, "variables": { {% for parameter in method.parameters.all %}"{{ parameter.name | caseCamel }}": {{ parameter | paramExample }}{% if not loop.last %}, {% endif %}{% endfor %} } }
4141

4242
--{{boundary}}
4343
Content-Disposition: form-data; name="map"
4444

4545
{% set counter = 0 %}
46-
{ {% for parameter in method.parameters.all | filter(p => p.required) %}{% if parameter.type == 'file' %}"{{ counter }}": ["variables.{{ parameter.name | caseCamel }}"]{% if not loop.last %}, {% endif %}{% set counter = counter + 1 %}{% endif %}{% endfor %} }
46+
{ {% for parameter in method.parameters.all %}{% if parameter.type == 'file' %}"{{ counter }}": ["variables.{{ parameter.name | caseCamel }}"]{% if not loop.last %}, {% endif %}{% set counter = counter + 1 %}{% endif %}{% endfor %} }
4747

4848
{% set counter = 0 %}
49-
{% for parameter in method.parameters.all | filter(p => p.required) %}
49+
{% for parameter in method.parameters.all %}
5050
{% if parameter.type == 'file' %}
5151
--{{ boundary }}
5252
Content-Disposition: form-data; name="{{ counter }}"; filename="{{ parameter.name }}.ext"
@@ -63,8 +63,8 @@ query {
6363
{%~ else %}
6464
mutation {
6565
{%~ endif %}
66-
{{ service.name | caseCamel }}{{ method.name | caseCamel | caseUcfirst }}{% if method.parameters.all | filter(p => p.required) | length == 0 %} {{ '{' }}{% else %}(
67-
{%~ for parameter in method.parameters.all | filter(p => p.required) %}
66+
{{ service.name | caseCamel }}{{ method.name | caseCamel | caseUcfirst }}{% if method.parameters.all | length == 0 %} {{ '{' }}{% else %}(
67+
{%~ for parameter in method.parameters.all %}
6868
{{ parameter.name | caseCamel }}: {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
6969

7070
{%~ endfor %}

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ Client client = new Client()
2626

2727
{% for parameter in method.parameters.all %}
2828
{% if parameter.required %}
29-
{{ parameter | paramExample }}{% if not loop.last %},{% endif %}
29+
{{ parameter | paramExample }}{% if not loop.last %},{% endif %} // {{parameter.name}}
3030

31+
{% else %}
32+
{{ parameter | paramExample }}{% if not loop.last %},{% endif %} // {{parameter.name}} (optional)
3133
{% endif %}
3234
{% if loop.last %}
3335
new CoroutineCallback<>((result, error) -> {

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ val {{ service.name | caseCamel }} = {{ service.name | caseUcfirst }}(client)
2020
{% if parameter.required %}
2121
{{parameter.name}} = {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
2222

23+
{% else %}
24+
{{parameter.name}} = {{ parameter | paramExample }}{% if not loop.last %},{% endif %} // optional
2325
{% endif %}
2426
{% if loop.last %}
2527
)

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,15 @@ 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 %}{{ parameter | paramExample }}{% endif %}{% endfor %});
21+
const promise = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}
22+
{% if loop.first %}
23+
24+
{% endif %}{% if parameter.required %}
25+
{{ parameter | paramExample }}{% if not loop.last %}, {% endif %} // {{parameter.name}}
26+
27+
{% else %}
28+
{{ parameter | paramExample }}{% if not loop.last %}, {% endif %} // {{parameter.name}} (optional)
29+
{% endif %}{% endfor %});
2230

2331
promise.then(function (response) {
2432
console.log(response);

0 commit comments

Comments
 (0)