Merge pull request #770 from appwrite/show-optional-params

eldadfux · web-flow · commit 8d932098009d · 2024-02-20T17:36:15.000+01:00
Show all optional params with comment
diff --git a/templates/android/docs/java/example.md.twig b/templates/android/docs/java/example.md.twig
@@ -26,8 +26,10 @@ Client client = new Client(context)
 
 {% for parameter in method.parameters.all %}
 {% if parameter.required %}
-    {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
+    {{ parameter | paramExample }}{% if not loop.last %},{% endif %} // {{parameter.name}}
 
+{% else %}
+    {{ parameter | paramExample }}{% if not loop.last %},{% endif %} // {{parameter.name}} (optional)
 {% endif %}
 {% if loop.last %}
     new CoroutineCallback<>((result, error) -> {
diff --git a/templates/android/docs/kotlin/example.md.twig b/templates/android/docs/kotlin/example.md.twig
@@ -20,6 +20,8 @@ val {{ service.name | caseCamel }} = {{ service.name | caseUcfirst }}(client)
 {% if parameter.required %}
     {{parameter.name}} = {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
 
+{% else %}
+    {{parameter.name}} = {{ parameter | paramExample }}{% if not loop.last %},{% endif %} // optional
 {% endif %}
 {% if loop.last %}
 )
diff --git a/templates/dart/docs/example.md.twig b/templates/dart/docs/example.md.twig
@@ -23,6 +23,8 @@ void main() { // Init SDK
 {% endif %}
 {% if parameter.required %}
     {{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }},
+{% else %}
+    {{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }}, // optional
 {% endif %}
 {% endfor %}{% if method.parameters.all | length > 0 %}  {% endif %});
 
diff --git a/templates/deno/docs/example.md.twig b/templates/deno/docs/example.md.twig
@@ -16,10 +16,17 @@ client
     .set{{header}}('{{node[header]['x-appwrite']['demo']}}') // {{node[header].description}}
 {% endfor %}
 {% endfor %};
-
 {% endif %}
 
-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 %});
+const promise = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}
+{% if loop.first %}
+
+    {% endif %}{% if parameter.required %}
+    {{ parameter | paramExample }}{% if not loop.last %}, {% endif %} // {{parameter.name}}
+    
+    {% else %}
+    {{ parameter | paramExample }}{% if not loop.last %}, {% endif %} // {{parameter.name}} (optional)
+    {% endif %}{% endfor %});
 
 promise.then(function (response) {
     console.log(response);
diff --git a/templates/dotnet/docs/example.md.twig b/templates/dotnet/docs/example.md.twig
@@ -15,4 +15,6 @@ var {{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}(client
 {% 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 %}
 {% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %},{% endif %}
 
-    {{ parameter.name }}: {{ parameter | paramExample }}{% endif %}{% endfor %}{% if method.parameters.all | length > 0 %});{% endif %}
+    {{ parameter.name }}: {{ parameter | paramExample }}{% if loop.last | length > 0 %});{% endif %}{% else %}
+    
+    {{ parameter.name }}: {{ parameter | paramExample }}{% if loop.last | length > 0 %});{% endif %} // optional{% endif %}{% endfor %}
diff --git a/templates/flutter/docs/example.md.twig b/templates/flutter/docs/example.md.twig
@@ -23,7 +23,9 @@ void main() { // Init SDK
 
 {% endif %}
 {% if parameter.required %}
-    {{ parameter.name | caseCamel }}: {{ parameter | paramExample }},
+    {{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }},
+{% else %}
+    {{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }}, // optional
 {% endif %}
 {% endfor %}{% if method.parameters.all | length > 0 %}  {% endif %}).then((bytes) {
     final file = File('path_to_file/filename.ext');
@@ -40,7 +42,9 @@ FutureBuilder(
 
 {% endif %}
 {% if parameter.required %}
-    {{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample }},
+    {{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }},
+{% else %}
+    {{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }}, // optional
 {% endif %}
 {% endfor %}{% if method.parameters.all | length > 0 %}  {% endif %}
 ), //works for both public file and private file, for private files you need to be logged in
@@ -58,7 +62,9 @@ FutureBuilder(
 
 {% endif %}
 {% if parameter.required %}
-    {{ parameter.name | caseCamel }}: {{ parameter | paramExample }},
+    {{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }},
+{% else %}
+    {{ parameter.name | caseCamel | overrideIdentifier }}: {{ parameter | paramExample | replace({'<field-name>': (parameter.name | caseCamel) }) | raw }}, // optional
 {% endif %}
 {% endfor %}{% if method.parameters.all | length > 0 %}  {% endif %});
 
diff --git a/templates/graphql/docs/example.md.twig b/templates/graphql/docs/example.md.twig
@@ -1,7 +1,7 @@
 {% macro getProperty(definitions, responseModel, depth) %}
         {%~ for definition in definitions %}
         {%~ if definition.name == responseModel %}
-        {%~ for property in definition.properties | filter(p => p.required) %}
+        {%~ for property in definition.properties  %}
         {{ ("% " ~ depth * 4 ~ "s") |format("") }}{{ property.name | replace({'$': '_'}) }}{%~ if property.sub_schema %} {{ '{' }}
             {{- '\n' -}}
                 {{- _self.getProperty(definitions, property.sub_schema, depth + 1) -}}
@@ -37,16 +37,16 @@ Content-Length: *Length of your entity body in bytes*
 --{{boundary}}
 Content-Disposition: form-data; name="operations"
 
-{ "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 %} } }
+{ "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 %} } }
 
 --{{boundary}}
 Content-Disposition: form-data; name="map"
 
 {% set counter = 0 %}
-{ {% 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 %} }
+{ {% 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 %} }
 
 {% set counter = 0 %}
-{% for parameter in method.parameters.all | filter(p => p.required) %}
+{% for parameter in method.parameters.all  %}
 {% if parameter.type == 'file' %}
 --{{ boundary }}
 Content-Disposition: form-data; name="{{ counter }}"; filename="{{ parameter.name }}.ext"
@@ -63,8 +63,8 @@ query {
 {%~ else %}
 mutation {
 {%~ endif %}
-    {{ service.name | caseCamel }}{{ method.name | caseCamel | caseUcfirst }}{% if method.parameters.all | filter(p => p.required) | length == 0 %} {{ '{' }}{% else %}(
-        {%~ for parameter in method.parameters.all | filter(p => p.required) %}
+    {{ service.name | caseCamel }}{{ method.name | caseCamel | caseUcfirst }}{% if method.parameters.all  | length == 0 %} {{ '{' }}{% else %}(
+        {%~ for parameter in method.parameters.all  %}
         {{ parameter.name | caseCamel }}: {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
 
         {%~ endfor %}
diff --git a/templates/kotlin/docs/java/example.md.twig b/templates/kotlin/docs/java/example.md.twig
@@ -26,8 +26,10 @@ Client client = new Client()
 
 {% for parameter in method.parameters.all %}
 {% if parameter.required %}
-    {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
+    {{ parameter | paramExample }}{% if not loop.last %},{% endif %} // {{parameter.name}}
 
+{% else %}
+    {{ parameter | paramExample }}{% if not loop.last %},{% endif %} // {{parameter.name}} (optional)
 {% endif %}
 {% if loop.last %}
     new CoroutineCallback<>((result, error) -> {
diff --git a/templates/kotlin/docs/kotlin/example.md.twig b/templates/kotlin/docs/kotlin/example.md.twig
@@ -20,6 +20,8 @@ val {{ service.name | caseCamel }} = {{ service.name | caseUcfirst }}(client)
 {% if parameter.required %}
     {{parameter.name}} = {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
 
+{% else %}
+    {{parameter.name}} = {{ parameter | paramExample }}{% if not loop.last %},{% endif %} // optional
 {% endif %}
 {% if loop.last %}
 )
diff --git a/templates/node/docs/example.md.twig b/templates/node/docs/example.md.twig
@@ -18,7 +18,15 @@ client
 {% endfor %};
 
 {% endif %}
-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 %});
+const promise = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}
+{% if loop.first %}
+
+    {% endif %}{% if parameter.required %}
+    {{ parameter | paramExample }}{% if not loop.last %}, {% endif %} // {{parameter.name}}
+    
+    {% else %}
+    {{ parameter | paramExample }}{% if not loop.last %}, {% endif %} // {{parameter.name}} (optional)
+    {% endif %}{% endfor %});
 
 promise.then(function (response) {
     console.log(response);
diff --git a/templates/php/docs/example.md.twig b/templates/php/docs/example.md.twig
@@ -20,4 +20,10 @@ $client
 {% endif %}
 ${{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}($client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %});
 
-$result = ${{ service.name | caseCamel }}->{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{ parameter | paramExample }}{% endif %}{% endfor %});
+$result = ${{ service.name | caseCamel }}->{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}{% if loop.first %} 
+{% endif %}
+    {% if parameter.required %}{{ parameter.name }}: {{ parameter | paramExample }}{% if not loop.last %}, {% endif %}
+
+{% else %}{{ parameter.name }}: {{ parameter | paramExample }}{% if not loop.last %}, {% endif %} // optional
+{% endif %}{% endfor %}
+);
diff --git a/templates/python/docs/example.md.twig b/templates/python/docs/example.md.twig
@@ -18,4 +18,11 @@ client = Client()
 {% endif %}
 {{ service.name | caseSnake }} = {{ service.name | caseUcfirst }}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %})
 
-result = {{ service.name | caseSnake }}.{{ method.name | caseSnake }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{ parameter | paramExample }}{% endif %}{% endfor %})
+result = {{ service.name | caseSnake }}.{{ method.name | caseSnake }}({% for parameter in method.parameters.all %}{% if loop.first %} 
+{% endif %}
+    {% if parameter.required %}{{ parameter.name | caseSnake }} = {{ parameter | paramExample }}{% if not loop.last %}, {% endif %}
+
+{% else %}{{ parameter.name | caseSnake }} = {{ parameter | paramExample }}{% if not loop.last %}, {% endif %} # optional
+{% endif %}{% endfor %}
+)
+
diff --git a/templates/ruby/docs/example.md.twig b/templates/ruby/docs/example.md.twig
@@ -12,6 +12,13 @@ client = Client.new
 
 {{ service.name | caseSnake }} = {{ service.name | caseUcfirst }}.new(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{parameter.name | caseSnake}}:{{ parameter | paramExample }}{% endfor %}{% endif %})
 
-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 %})
+response = {{ service.name | caseSnake }}.{{ method.name | caseSnake }}({% for parameter in method.parameters.all %}{% if loop.first %}
+
+{% endif %}
+    {% if parameter.required %}{{parameter.name|caseSnake}}: {% if parameter.type == 'file' %}{{ parameter | paramExample }}{% else %}{{ parameter | paramExample }}{% if not loop.last %}, {% endif %}{% endif %}
+
+{% else %}{{parameter.name|caseSnake}}: {% if parameter.type == 'file' %}{{ parameter | paramExample }}{% else %}{{ parameter | paramExample }}{% if not loop.last %}, {% endif %} # optional
+{% endif %}
+{% endif %}{% endfor %})
 
 puts response.inspect
diff --git a/templates/swift/docs/example.md.twig b/templates/swift/docs/example.md.twig
@@ -12,10 +12,11 @@ let client = Client()
 
 let {{ service.name | caseCamel }} = {{ service.name | caseUcfirst }}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %})
 
-let {% if method.type == 'webAuth' %}success{% elseif method.type == 'location' %}byteBuffer{% elseif method.responseModel | length == 0 %}result{% else %}{{ method.responseModel | caseCamel | escapeKeyword }}{% endif %} = try await {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | filter((param) => param.required) | length == 0 %}){{ '\n' }}{% endif %}
+let {% if method.type == 'webAuth' %}success{% elseif method.type == 'location' %}byteBuffer{% elseif method.responseModel | length == 0 %}result{% else %}{{ method.responseModel | caseCamel | escapeKeyword }}{% endif %} = try await {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %}){{ '\n' }}{% endif %}
 
-{% for parameter in method.parameters.all | filter((parameter) => parameter.required) %}
-    {{parameter.name}}: {{ parameter | paramExample | escapeKeyword }}{% if not loop.last %},{% endif %}
+{% for parameter in method.parameters.all %}{% if loop.first %}
+{% endif %}{% if parameter.required %}  {{parameter.name}}: {{ parameter | paramExample | escapeKeyword }}{% if not loop.last %},{% endif %}
+{% else %}  {{parameter.name}}: {{ parameter | paramExample | escapeKeyword }}{% if not loop.last %},{% endif %} // optional{% endif %}
 {% if loop.last %}
 
 )
diff --git a/templates/web/docs/example.md.twig b/templates/web/docs/example.md.twig
@@ -1,4 +1,4 @@
-import {{ '{' }} Client, {{service.name | caseUcfirst}} {{ '}' }} from "{{ language.params.npmPackage }}";
+import {{ '{' }} Client, {{service.name | caseUcfirst}} {{ '}' }} from "{{ spec.title | caseDash }}";
 
 const client = new Client();
 
@@ -16,7 +16,15 @@ client
 {% endif %}
 {% if method.type == 'webAuth' %}// Go to OAuth provider login page
 {% endif %}
-{% if method.type == 'webAuth' %}{% elseif method.type == 'location' %}const result = {% else %}const promise = {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{ parameter | paramExample }}{% endif %}{% endfor %});
+{% if method.type == 'webAuth' %}{% elseif method.type == 'location' %}const result = {% else %}const promise = {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}
+{% if loop.first %}
+
+    {% endif %}{% if parameter.required %}
+    {{ parameter | paramExample }}{% if not loop.last %}, {% endif %} // {{parameter.name}}
+    
+    {% else %}
+    {{ parameter | paramExample }}{% if not loop.last %}, {% endif %} // {{parameter.name}} (optional)
+    {% endif %}{% endfor %});
 
 {% if method.type == 'webAuth' %}{% elseif method.type == 'location' %}console.log(result); // Resource URL{% else %}promise.then(function (response) {
     console.log(response); // Success

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,8 @@ val {{ service.name \| caseCamel }} = {{ service.name \| caseUcfirst }}(client)`
`20`	`20`	`{% if parameter.required %}`
`21`	`21`	`{{parameter.name}} = {{ parameter \| paramExample }}{% if not loop.last %},{% endif %}`
`22`	`22`
	`23`	`+{% else %}`
	`24`	`+ {{parameter.name}} = {{ parameter \| paramExample }}{% if not loop.last %},{% endif %} // optional`
`23`	`25`	`{% endif %}`
`24`	`26`	`{% if loop.last %}`
`25`	`27`	`)`