documentation: fixing api_doc to generate meaningful example

[arnaudgeiser]

Fixing the api_doc.mustache to generate a more meaningful example, below is a code snippet of the generated examples for different kinds of HTTP methods:

getInstance

Instance getInstance(id)

Retrieve Compute instance details

Example

// Import classes:
import com.exoscale.sdk.client.ApiException;
import com.exoscale.sdk.client.*;
import com.exoscale.sdk.client.models.*;
import com.exoscale.sdk.api.ExoscaleApi;

public class Example {
    public static void main(String[] args) throws ApiException, InterruptedException{
        // Initialize the client with credentials
        Client client = new Client(new Credentials(System.getenv("EXOSCALE_API_KEY"), System.getenv("EXOSCALE_API_SECRET")));
        UUID id = UUID.randomUUID(); // UUID | 

        try {
            // Invoke the API method
            Instance result = client.getInstance(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExoscaleApi#getInstance");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

createInstance

Operation createInstance(createInstanceRequest)

Create a Compute instance

Example

// Import classes:
import com.exoscale.sdk.client.ApiException;
import com.exoscale.sdk.client.*;
import com.exoscale.sdk.client.models.*;
import com.exoscale.sdk.api.ExoscaleApi;

public class Example {
    public static void main(String[] args) throws ApiException, InterruptedException{
        // Initialize the client with credentials
        Client client = new Client(new Credentials(System.getenv("EXOSCALE_API_KEY"), System.getenv("EXOSCALE_API_SECRET")));
        CreateInstanceRequest createInstanceRequest = new CreateInstanceRequest(); // CreateInstanceRequest |  please add at least all the required fields

        try {
            // Invoke the API method
            Operation result = client.createInstance(createInstanceRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExoscaleApi#createInstance");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

deleteInstance

Operation deleteInstance(id)

Delete a Compute instance

Example

// Import classes:
import com.exoscale.sdk.client.ApiException;
import com.exoscale.sdk.client.*;
import com.exoscale.sdk.client.models.*;
import com.exoscale.sdk.api.ExoscaleApi;

public class Example {
    public static void main(String[] args) throws ApiException, InterruptedException{
        // Initialize the client with credentials
        Client client = new Client(new Credentials(System.getenv("EXOSCALE_API_KEY"), System.getenv("EXOSCALE_API_SECRET")));
        UUID id = UUID.randomUUID(); // UUID | 

        try {
            // Invoke the API method
            Operation result = client.deleteInstance(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExoscaleApi#deleteInstance");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

updateInstance

Operation updateInstance(id, updateInstanceRequest)

Update a Compute instance

Example

// Import classes:
import com.exoscale.sdk.client.ApiException;
import com.exoscale.sdk.client.*;
import com.exoscale.sdk.client.models.*;
import com.exoscale.sdk.api.ExoscaleApi;

public class Example {
    public static void main(String[] args) throws ApiException, InterruptedException{
        // Initialize the client with credentials
        Client client = new Client(new Credentials(System.getenv("EXOSCALE_API_KEY"), System.getenv("EXOSCALE_API_SECRET")));
        UUID id = UUID.randomUUID(); // UUID | 
        UpdateInstanceRequest updateInstanceRequest = new UpdateInstanceRequest(); // UpdateInstanceRequest |  please add at least all the required fields

        try {
            // Invoke the API method
            Operation result = client.updateInstance(id, updateInstanceRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExoscaleApi#updateInstance");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Some insight on templates have been taken from DefaultCodegen.java