Skip to content

Commit 8dd3577

Browse files
TorstenDittmannTorstenDittmann
authored
Merge pull request #478 from appwrite/feat-global-params-in-docs
Feat : Global params in docs
2 parents 17cdffc + 093b494 commit 8dd3577

File tree

17 files changed

+54
-45
lines changed

17 files changed

+54
-45
lines changed

‎specs/swagger2-latest-console.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎src/SDK/SDK.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -584,6 +584,7 @@ public function generate($target)
584584
$params['service'] = [
585585
'name' => $key,
586586
'methods' => $methods,
587+
'globalParams' => $service['globalParams'] ?? [],
587588
'features' => [
588589
'upload' => $this->hasUploads($methods),
589590
'location' => $this->hasLocation($methods),

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ public class MainActivity extends AppCompatActivity {
2222
{% endfor %}
2323
{% endif %}
2424

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

27-
{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %}new Continuation<Object>() {
27+
{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | filter((param) => not param.isGlobal) | length == 0 %}new Continuation<Object>() {
2828
@NotNull
2929
@Override
3030
public CoroutineContext getContext() {
@@ -53,7 +53,7 @@ public class MainActivity extends AppCompatActivity {
5353
{% if method.type == "webAuth" %}
5454
this,
5555
{% endif %}
56-
{% for parameter in method.parameters.all %}
56+
{% for parameter in method.parameters.all | filter((param) => not param.isGlobal) %}
5757
{% if parameter.required %}
5858
{{ parameter | paramExample }}{% if not loop.last %}, {% endif %}
5959

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ class MainActivity : AppCompatActivity() {
2020
{% endfor %}
2121
{% endif %}
2222

23-
val {{ service.name | caseCamel }} = {{ service.name | caseUcfirst }}(client)
23+
val {{ service.name | caseCamel }} = {{ service.name | caseUcfirst }}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %})
2424

2525
GlobalScope.launch {
26-
{% if method.type == 'webAuth' %} {% elseif method.type == 'location' %} val result = {% else %} val response = {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %}){% endif %}
26+
{% if method.type == 'webAuth' %} {% elseif method.type == 'location' %} val result = {% else %} val response = {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | filter((param) => not param.isGlobal) | length == 0 %}){% endif %}
2727

2828
{% if method.type == "webAuth" %}
2929
activity = this@MainActivity,
3030
{% endif %}
31-
{% for parameter in method.parameters.all %}
31+
{% for parameter in method.parameters.all | filter((param) => not param.isGlobal) %}
3232
{% if parameter.required %}
3333
{{parameter.name}} = {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
3434

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import 'package:{{ language.params.packageName }}/{{ language.params.packageName
55

66
void main() { // Init SDK
77
Client client = Client();
8-
{{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = {{service.name | caseUcfirst}}(client);
8+
{{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = {{service.name | caseUcfirst}}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %});
99

1010
{% if method.security|length > 0 %}
1111
client
@@ -17,14 +17,14 @@ void main() { // Init SDK
1717
{% endfor %} ;
1818

1919
{% endif %}
20-
Future result = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}
20+
Future result = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all | filter((param) => not param.isGlobal) %}
2121
{% if loop.first %}
2222

2323
{% endif %}
2424
{% if parameter.required %}
2525
{{ parameter.name | caseCamel }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }},
2626
{% endif %}
27-
{% endfor %}{% if method.parameters.all|length > 0 %} {% endif %});
27+
{% endfor %}{% if method.parameters.all | filter((param) => not param.isGlobal) | length > 0 %} {% endif %});
2828

2929
result
3030
.then((response) {

‎templates/deno/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
let client = new sdk.Client();
88

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

1111
{% if method.security|length > 0 %}
1212
client
@@ -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 %}{{ parameter | paramExample }}{% endif %}{% endfor %});
22+
let promise = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all | filter((param) => not param.isGlobal) %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{ parameter | paramExample }}{% endif %}{% endfor %});
2323

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ client
1212
{% endfor %};
1313

1414
{% endif %}
15-
{{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}(client);
15+
{{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %});
1616

17-
{% if method.type == 'location' %}string{% else %}HttpResponseMessage{% endif %} result = await {{ service.name | caseCamel }}.{{ method.name | caseUcfirst }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{ parameter | paramExample }}{% endif %}{% endfor %});
17+
{% if method.type == 'location' %}string{% else %}HttpResponseMessage{% endif %} result = await {{ service.name | caseCamel }}.{{ method.name | caseUcfirst }}({% for parameter in method.parameters.all | filter((param) => not param.isGlobal) %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{ parameter | paramExample }}{% endif %}{% endfor %});

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import 'package:{{ language.params.packageName }}/{{ language.params.packageName
55

66
void main() { // Init SDK
77
Client client = Client();
8-
{{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = {{service.name | caseUcfirst}}(client);
8+
{{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = {{service.name | caseUcfirst}}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %});
99

1010
{% if method.security|length > 0 %}
1111
client
@@ -18,14 +18,14 @@ void main() { // Init SDK
1818
{% endif %}
1919
{% if method.type == 'location' %}
2020
// downloading file
21-
Future result = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}
21+
Future result = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all | filter((param) => not param.isGlobal) %}
2222
{% if loop.first %}
2323

2424
{% endif %}
2525
{% if parameter.required %}
2626
{{ parameter.name | caseCamel }}: {{ parameter | paramExample }},
2727
{% endif %}
28-
{% endfor %}{% if method.parameters.all|length > 0 %} {% endif %}).then((bytes) {
28+
{% endfor %}{% if method.parameters.all | filter((param) => not param.isGlobal) | length > 0 %} {% endif %}).then((bytes) {
2929
final file = File('path_to_file/filename.ext');
3030
file.writeAsBytesSync(bytes)
3131
}).catchError((error) {
@@ -35,14 +35,14 @@ void main() { // Init SDK
3535

3636
//displaying image preview
3737
FutureBuilder(
38-
future: {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}
38+
future: {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all | filter((param) => not param.isGlobal) %}
3939
{% if loop.first %}
4040

4141
{% endif %}
4242
{% if parameter.required %}
4343
{{ parameter.name | caseCamel }}: {{ parameter | paramExample }},
4444
{% endif %}
45-
{% endfor %}{% if method.parameters.all|length > 0 %} {% endif %}
45+
{% endfor %}{% if method.parameters.all | filter((param) => not param.isGlobal) | length > 0 %} {% endif %}
4646
), //works for both public file and private file, for private files you need to be logged in
4747
builder: (context, snapshot) {
4848
return snapshot.hasData && snapshot.data != null
@@ -53,14 +53,14 @@ FutureBuilder(
5353
},
5454
);
5555
{% else %}
56-
Future result = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}
56+
Future result = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all | filter((param) => not param.isGlobal) %}
5757
{% if loop.first %}
5858

5959
{% endif %}
6060
{% if parameter.required %}
6161
{{ parameter.name | caseCamel }}: {{ parameter | paramExample }},
6262
{% endif %}
63-
{% endfor %}{% if method.parameters.all|length > 0 %} {% endif %});
63+
{% endfor %}{% if method.parameters.all | filter((param) => not param.isGlobal) | length > 0 %} {% endif %});
6464

6565
result
6666
.then((response) {

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ public void main() {
1010
.set{{header | caseUcfirst}}("{{node[header]['x-appwrite']['demo']}}"){% if loop.last %};{% endif %} // {{node[header].description}}
1111
{% endfor %}{% endfor %}{% endif %}
1212

13-
{{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}(client);
14-
{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %}new Continuation<Response>() {
13+
{{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %});
14+
{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | filter((param) => not param.isGlobal) | length == 0 %}new Continuation<Response>() {
1515
@NotNull
1616
@Override
1717
public CoroutineContext getContext() {
@@ -34,7 +34,7 @@ public void main() {
3434
}
3535
});{% endif %}
3636

37-
{% for parameter in method.parameters.all %}
37+
{% for parameter in method.parameters.all | filter((param) => not param.isGlobal) %}
3838
{% if parameter.required %}
3939
{{parameter.name}} = {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
4040

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ suspend fun main() {
1010
.set{{header | caseUcfirst}}("{{node[header]['x-appwrite']['demo']}}") // {{node[header].description}}
1111
{% endfor %}{% endfor %}{% endif %}
1212

13-
val {{ service.name | caseCamel }} = {{ service.name | caseUcfirst }}(client)
14-
{% if method.type == 'webAuth' %} {% elseif method.type == 'location' %} val result = {% else %} val response = {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %}){% endif %}
13+
val {{ service.name | caseCamel }} = {{ service.name | caseUcfirst }}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %})
14+
{% if method.type == 'webAuth' %} {% elseif method.type == 'location' %} val result = {% else %} val response = {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | filter((param) => not param.isGlobal) | length == 0 %}){% endif %}
1515

16-
{% for parameter in method.parameters.all %}
16+
{% for parameter in method.parameters.all | filter((param) => not param.isGlobal) %}
1717
{% if parameter.required %}
1818
{{parameter.name}} = {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
1919

0 commit comments

Comments
 (0)