update API spec URL and add deprecation handling in templates

Author: ChiragAgg5k

example.php

@@ -42,7 +42,7 @@ function getSSLPage($url) {
      $platform = 'console';
     // $platform = 'server';
 
-    $spec = getSSLPage("https://raw.githubusercontent.com/appwrite/appwrite/1.7.x/app/config/specs/swagger2-latest-{$platform}.json");
+    $spec = getSSLPage("https://raw.githubusercontent.com/appwrite/appwrite/deprecate-old-methods/app/config/specs/swagger2-1.8.x-{$platform}.json");
 
     if(empty($spec)) {
         throw new Exception('Failed to fetch spec from Appwrite server');

src/SDK/SDK.php

@@ -207,6 +207,9 @@ public function __construct(Language $language, Spec $spec)
             }
             return $value;
         }));
+        $this->twig->addFilter(new TwigFilter('capitalizeFirst', function ($value) {
+            return ucfirst($value);
+        }));
     }
 
     /**

src/Spec/Swagger2.php

@@ -176,6 +176,8 @@ protected function parseMethod(string $methodName, string $pathName, array $meth
             'consumes' => $method['consumes'] ?? [],
             'cookies' => $method['x-appwrite']['cookies'] ?? false,
             'type' => $method['x-appwrite']['type'] ?? false,
+            'deprecated' => $method['x-appwrite']['deprecated'] ?? false,
+            'replaceWith' => $method['x-appwrite']['replaceWith'] ?? '',
             'headers' => [],
             'parameters' => [
                 'all' => [],

templates/android/library/src/main/java/io/package/services/Service.kt.twig

@@ -38,6 +38,18 @@ class {{ service.name | caseUcfirst }}(client: Client) : Service(client) {
      * @return [{{ method | returnType(spec, sdk.namespace | caseDot) | raw }}]
     {%~ endif %}
      */
+    {%~ if method.deprecated %}
+{% set deprecated_message = "This API is deprecated and uses outdated terminologies." %}
+{% if method.replaceWith %}
+{% set deprecated_message = deprecated_message ~ ' Please use ' ~ (method.replaceWith | capitalizeFirst) ~ ' instead.' %}
+    @Deprecated(
+        "{{ deprecated_message }}",
+        ReplaceWith("{{ sdk.namespace | caseDot }}.services.{{ method.replaceWith | capitalizeFirst }}")
+    )
+{% else %}
+    @Deprecated("{{ deprecated_message }}")
+{% endif %}
+{%~ endif %}
     {%~ if method.parameters.all | reduce((carry, param) => carry or not param.required) %}
     @JvmOverloads
     {%~ endif %}
@@ -192,6 +204,18 @@ class {{ service.name | caseUcfirst }}(client: Client) : Service(client) {
      * @return [{{ method | returnType(spec, sdk.namespace | caseDot) | raw }}]
     {%~ endif %}
      */
+    {%~ if method.deprecated %}
+{% set deprecated_message = "This API is deprecated and uses outdated terminologies." %}
+{% if method.replaceWith %}
+{% set deprecated_message = deprecated_message ~ ' Please use ' ~ (method.replaceWith | capitalizeFirst) ~ ' instead.' %}
+    @Deprecated(
+        "{{ deprecated_message }}",
+        ReplaceWith("{{ sdk.namespace | caseDot }}.services.{{ method.replaceWith | capitalizeFirst }}")
+    )
+{% else %}
+    @Deprecated("{{ deprecated_message }}")
+{% endif %}
+{%~ endif %}
     {%~ if method.parameters.all | reduce((carry, param) => carry or not param.required) %}
     @JvmOverloads
     {%~ endif %}