Patch.md

Patch

public class Patch

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	Patch1 The class that has a patch method to call the endpoint
static class	PatchRequest The request inputs class
static class	PatchRequestBuilder A builder for the request input class

Patch1

public static class Patch1 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.paths.fakejsonpatch.patch.RequestBody;
import org.openapijsonschematools.client.components.schemas.JSONPatchRequest;
import org.openapijsonschematools.client.RootServerInfo;
import org.openapijsonschematools.client.servers.Server0;
import org.openapijsonschematools.client.servers.Server1;
import org.openapijsonschematools.client.servers.Server2;
import org.openapijsonschematools.client.paths.fakejsonpatch.patch.responses.Code200Response;
import org.openapijsonschematools.client.paths.fakejsonpatch.Patch;

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

// if you want to use a sever that is not SERVER_0 pass it in here and change the ServerIndex input below
ApiConfiguration.ServerInfo serverInfo = new ApiConfiguration.ServerInfo(
    new Server0(),
    null,
    null
);
ApiConfiguration.ServerIndexInfo serverIndexInfo = new ApiConfiguration.ServerIndexInfo()
    .rootServerInfoServerIndex(RootServerInfo.ServerIndex.SERVER_0);
Duration timeout = Duration.ofSeconds(1L);
ApiConfiguration apiConfiguration = new ApiConfiguration(
    serverInfo
    serverIndexInfo,
    timeout
);
SchemaConfiguration schemaConfiguration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());
Patch.Patch1 apiClient = new Patch.Patch1(apiConfiguration, schemaConfiguration);


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

Responses.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;
}
Responses.EndpointCode200Response castResponse = (Responses.EndpointCode200Response) response;

Constructor Summary

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

Method Summary

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

PatchRequest

public static class PatchRequest

a class that stores the final request inputs

Field Summary

Modifier and Type	Field and Description
RequestBody.@Nullable SealedRequestBody	requestBody optional
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

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
PatchRequest	build() Returns the request input used to call an endpoint method
PatchRequestBuilder	requestBody(RequestBody.SealedRequestBody requestBody) sets the optional property
PatchRequestBuilder	serverIndex(RootServerInfo.ServerIndex serverIndex) sets the optional property. Note: this will override the value in apiConfiguration
PatchRequestBuilder	timeout(Duration timeout) sets the optional property. Note: this will override the value in apiConfiguration

[Back to top] [Back to README]