loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/samples/client/echo_api/java/native/docs/HeaderApi.md
Robert Schweizer 9e07f85eb5
[python] Add tests and fix enum path parameters (#16769) 
* test: Tests for enum params in path, query and header

* fix: Get enum ref values correctly in path parameters

Closes #16688

* fix java tests failure

---------

Co-authored-by: William Cheng <wing328hk@gmail.com>
2023-10-10 17:10:30 +08:00

5.7 KiB
Raw Blame History

HeaderApi

All URIs are relative to http://localhost:3000

Method HTTP request Description
testHeaderIntegerBooleanStringEnums GET /header/integer/boolean/string/enums Test header parameter(s)
testHeaderIntegerBooleanStringEnumsWithHttpInfo GET /header/integer/boolean/string/enums Test header parameter(s)

testHeaderIntegerBooleanStringEnums

String testHeaderIntegerBooleanStringEnums(integerHeader, booleanHeader, stringHeader, enumNonrefStringHeader, enumRefStringHeader)

Test header parameter(s)

Test header parameter(s)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.HeaderApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:3000");

        HeaderApi apiInstance = new HeaderApi(defaultClient);
        Integer integerHeader = 56; // Integer | 
        Boolean booleanHeader = true; // Boolean | 
        String stringHeader = "stringHeader_example"; // String | 
        String enumNonrefStringHeader = "success"; // String | 
        StringEnumRef enumRefStringHeader = StringEnumRef.fromValue("success"); // StringEnumRef | 
        try {
            String result = apiInstance.testHeaderIntegerBooleanStringEnums(integerHeader, booleanHeader, stringHeader, enumNonrefStringHeader, enumRefStringHeader);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HeaderApi#testHeaderIntegerBooleanStringEnums");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
integerHeader Integer [optional]
booleanHeader Boolean [optional]
stringHeader String [optional]
enumNonrefStringHeader String [optional] [enum: success, failure, unclassified]
enumRefStringHeader StringEnumRef [optional] [enum: success, failure, unclassified]

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 Successful operation -

testHeaderIntegerBooleanStringEnumsWithHttpInfo

ApiResponse testHeaderIntegerBooleanStringEnums testHeaderIntegerBooleanStringEnumsWithHttpInfo(integerHeader, booleanHeader, stringHeader, enumNonrefStringHeader, enumRefStringHeader)

Test header parameter(s)

Test header parameter(s)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.ApiResponse;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.HeaderApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:3000");

        HeaderApi apiInstance = new HeaderApi(defaultClient);
        Integer integerHeader = 56; // Integer | 
        Boolean booleanHeader = true; // Boolean | 
        String stringHeader = "stringHeader_example"; // String | 
        String enumNonrefStringHeader = "success"; // String | 
        StringEnumRef enumRefStringHeader = StringEnumRef.fromValue("success"); // StringEnumRef | 
        try {
            ApiResponse<String> response = apiInstance.testHeaderIntegerBooleanStringEnumsWithHttpInfo(integerHeader, booleanHeader, stringHeader, enumNonrefStringHeader, enumRefStringHeader);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling HeaderApi#testHeaderIntegerBooleanStringEnums");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
integerHeader Integer [optional]
booleanHeader Boolean [optional]
stringHeader String [optional]
enumNonrefStringHeader String [optional] [enum: success, failure, unclassified]
enumRefStringHeader StringEnumRef [optional] [enum: success, failure, unclassified]

Return type

ApiResponse<String>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 Successful operation -