com.qdesrame.openapi.diff.compare.OperationDiff Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi-diff Show documentation
Utility for comparing two OpenAPI specifications.
The newest version!
package com.qdesrame.openapi.diff.compare;

import com.qdesrame.openapi.diff.model.ChangedOperation;
import com.qdesrame.openapi.diff.model.ChangedParameters;
import io.swagger.v3.oas.models.Operation;
import io.swagger.v3.oas.models.PathItem;
import io.swagger.v3.oas.models.parameters.Parameter;

import java.util.List;
import java.util.Map;
import java.util.Optional;

/**
 * Created by adarsh.sharma on 04/01/18.
 */
public class OperationDiff {
    private OpenApiDiff openApiDiff;

    public OperationDiff(OpenApiDiff openApiDiff) {
        this.openApiDiff = openApiDiff;
    }

    public Optional diff(String pathUrl, PathItem.HttpMethod method, Map pathParameters, Operation oldOperation, Operation newOperation) {
        ChangedOperation changedOperation = new ChangedOperation(pathUrl, method, oldOperation, newOperation);

        changedOperation.setSummary(newOperation.getSummary());
        changedOperation.setDeprecated(!Boolean.TRUE.equals(oldOperation.getDeprecated()) && Boolean.TRUE.equals(newOperation.getDeprecated()));

        if (oldOperation.getRequestBody() != null || newOperation.getRequestBody() != null) {
            openApiDiff.getRequestBodyDiff().diff(oldOperation.getRequestBody(), newOperation.getRequestBody())
                    .ifPresent(changedOperation::setChangedRequestBody);
        }

        openApiDiff.getParametersDiff().diff(oldOperation.getParameters(), newOperation.getParameters())
                .ifPresent(params -> {
                    removePathParameters(pathParameters, params);
                    changedOperation.setChangedParameters(params);
                });

        if (oldOperation.getResponses() != null || newOperation.getResponses() != null) {
            openApiDiff.getApiResponseDiff().diff(oldOperation.getResponses(), newOperation.getResponses())
                    .ifPresent(changedOperation::setChangedApiResponse);
        }

        if (oldOperation.getSecurity() != null || newOperation.getSecurity() != null) {
            openApiDiff.getSecurityRequirementsDiff().diff(oldOperation.getSecurity(), newOperation.getSecurity())
                    .ifPresent(changedOperation::setChangedSecurityRequirements);
        }

        return changedOperation.isDiff() ? Optional.of(changedOperation) : Optional.empty();
    }

    public void removePathParameters(Map pathParameters, ChangedParameters params) {
        pathParameters.forEach((oldParam, newParam) -> {
            removePathParameter(oldParam, params.getMissing());
            removePathParameter(newParam, params.getIncreased());
        });
    }

    public void removePathParameter(String name, List parameters) {
        parameters.stream().filter(p -> "path".equals(p.getIn()) && name.equals(p.getName())).findFirst()
                .ifPresent(parameters::remove);
    }
}