Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Latest commit

 

History

History
188 lines (156 loc) · 9.02 KB

File metadata and controls

188 lines (156 loc) · 9.02 KB

AnotherfakedummyPatch

public class AnotherfakedummyPatch

A class that contains necessary endpoint classes

  • a class that calls the endpoint method using the http verb
  • a class that calls the endpoint method using the operationId name
  • class(es) to store the request inputs
  • builder(s) to set the request input data

Nested Class Summary

Modifier and Type Class and Description
static class Patch
The class that has a patch method to call the endpoint
interface Model123TestSpecialTagsOperation
The interface that has a model123TestSpecialTags method to call the endpoint
static class PatchRequest
The final request inputs class
static class PatchNullableRequest
The initial request inputs class
static class Patch0RequestBuilder
A builder for the request input class
static class PatchRequestBuilder
A builder for the request input class

Patch

public static class Patch extends ApiClient.ApiClient1 implements PatchOperation

a class that allows one to call the endpoint using a method named patch

Code Sample

import org.openapijsonschematools.client.configurations.ApiConfiguration;
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
import org.openapijsonschematools.client.exceptions.ValidationException;
import org.openapijsonschematools.client.exceptions.NotImplementedException;
import org.openapijsonschematools.client.exceptions.ApiException;
import org.openapijsonschematools.client.schemas.validation.MapUtils;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;
import org.openapijsonschematools.client.RootServerInfo;
import org.openapijsonschematools.client.paths.anotherfakedummy.patch.AnotherfakedummyPatchRequestBody;
import org.openapijsonschematools.client.components.schemas.Client;
import org.openapijsonschematools.client.servers.RootServer0;
import org.openapijsonschematools.client.servers.RootServer1;
import org.openapijsonschematools.client.servers.RootServer2;
import org.openapijsonschematools.client.paths.anotherfakedummy.patch.responses.AnotherfakedummyPatchCode200Response;
import org.openapijsonschematools.client.servers.RootServerInfo;
import org.openapijsonschematools.client.paths.anotherfakedummy.AnotherfakedummyPatch;
import org.openapijsonschematools.client.paths.anotherfakedummy.patch.AnotherfakedummyPatchResponses;

import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.AbstractMap;

// if you want to use a server that is not SERVER_0 pass it in here and change the ServerIndex input below
ApiConfiguration.ServerInfo serverInfo = new ApiConfiguration.ServerInfoBuilder()
    .rootServerInfo(
        new RootServerInfo.RootServerInfoBuilder()
            .rootServer0(new RootServer0())
            .build()
    )
    .build();
ApiConfiguration.ServerIndexInfo serverIndexInfo = new ApiConfiguration.ServerIndexInfoBuilder()
    .rootServerInfoServerIndex(RootServerInfo.ServerIndex.SERVER_0)
    .build();
Duration timeout = Duration.ofSeconds(1L);
Map<String, List<String>> defaultHeaders = Map.of("User-Agent", List.of("OpenAPI-JSON-Schema-Generator/1.0.0/java"));
ApiConfiguration apiConfiguration = new ApiConfiguration(
    serverInfo
    serverIndexInfo,
    timeout,
    defaultHeaders
);
SchemaConfiguration schemaConfiguration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());
AnotherfakedummyPatch.Patch apiClient = new AnotherfakedummyPatch.Patch(apiConfiguration, schemaConfiguration);


Client1BoxedMap requestBodyPayload =
    Client.Client1.validateAndBox(
    new Client.ClientMapBuilder1()
        .client("a")

    .build(),
    schemaConfiguration
);
AnotherfakedummyPatchRequestBody.SealedRequestBody requestBody = new AnotherfakedummyPatchRequestBody.ApplicationjsonRequestBody(requestBodyPayload);

var request = new AnotherfakedummyPatch.PatchRequestBuilder()
    .requestBody(requestBody)
    .build();

AnotherfakedummyPatchResponses.EndpointResponse response;
try {
    response = apiClient.patch(request);
} catch (ApiException e) {
    // server returned a response/contentType not defined in the openapi document
    throw e;
} catch (ValidationException e) {
    // the returned response body or header values do not conform the the schema validation requirements
    throw e;
} catch (IOException | InterruptedException e) {
    // an exception happened when making the request
    throw e;
} catch (NotImplementedException e) {
    // the request body serialization or deserialization has not yet been implemented
    // or the header content type deserialization has not yet been implemented for this contentType
    throw e;
}
AnotherfakedummyPatchResponses.EndpointAnotherfakedummyPatchCode200Response castResponse = (AnotherfakedummyPatchResponses.EndpointAnotherfakedummyPatchCode200Response) response;
AnotherfakedummyPatchCode200Response.ApplicationjsonResponseBody deserializedBody = (AnotherfakedummyPatchCode200Response.ApplicationjsonResponseBody) castResponse.body;
// handle deserialized body here

Constructor Summary

Constructor and Description
Patch(ApiConfiguration apiConfiguration, SchemaConfiguration schemaConfiguration)
Creates an instance

Method Summary

Modifier and Type Method and Description
AnotherfakedummyPatchResponses.EndpointResponse patch(PatchRequest request)

Model123TestSpecialTagsOperation

public interface Model123TestSpecialTagsOperation

an interface that allows one to call the endpoint using a method named model123TestSpecialTags by the operationId

Method Summary

Modifier and Type Method and Description
AnotherfakedummyPatchResponses.EndpointResponse model123TestSpecialTags(PatchRequest request)

PatchRequest

public static class PatchRequest

a class that stores the final request inputs

Field Summary

Modifier and Type Field and Description
AnotherfakedummyPatchRequestBody.SealedRequestBody requestBody
RootServerInfo.@Nullable ServerIndex serverIndex
optional. Note: this will override the value in apiConfiguration
@Nullable Duration timeout
optional. Note: this will override the value in apiConfiguration

PatchNullableRequest

public static class PatchNullableRequest

a class that stores the initial request inputs

Field Summary

Modifier and Type Field and Description
AnotherfakedummyPatchRequestBody.@Nullable SealedRequestBody requestBody
RootServerInfo.@Nullable ServerIndex serverIndex
@Nullable Duration timeout

Patch0RequestBuilder

public static class Patch0RequestBuilder

a builder for request inputs

Constructor Summary

Constructor and Description
Patch0RequestBuilder(Patch0RequestBuilder instance)
Creates a builder that contains the passed instance

Method Summary

Modifier and Type Method and Description
PatchRequest build()
Returns the request input used to call an endpoint method
Patch0RequestBuilder serverIndex(RootServerInfo.ServerIndex serverIndex)
sets the optional property. Note: this will override the value in apiConfiguration
Patch0RequestBuilder timeout(Duration timeout)
sets the optional property. Note: this will override the value in apiConfiguration

PatchRequestBuilder

public static class PatchRequestBuilder

a builder for request inputs

Constructor Summary

Constructor and Description
PatchRequestBuilder()
Creates a builder that contains null for all parameters

Method Summary

Modifier and Type Method and Description
Patch0RequestBuilder requestBody(AnotherfakedummyPatchRequestBody.SealedRequestBody requestBody)
sets the property

[Back to top] [Back to README]