software.amazon.smithy.openapi.fromsmithy.mappers.RemoveEmptyComponents Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smithy-openapi Show documentation

This module contains support for converting a Smithy model to OpenAPI.

There is a newer version: 1.51.0

/*
 * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

package software.amazon.smithy.openapi.fromsmithy.mappers;

import java.util.Map;
import software.amazon.smithy.model.node.Node;
import software.amazon.smithy.model.node.ObjectNode;
import software.amazon.smithy.model.traits.Trait;
import software.amazon.smithy.openapi.fromsmithy.Context;
import software.amazon.smithy.openapi.fromsmithy.OpenApiMapper;
import software.amazon.smithy.openapi.model.OpenApi;
import software.amazon.smithy.utils.SmithyInternalApi;

/**
 * Removes empty key-value pairs in the "components" of a model if empty, and
 * removes the "components" key-value pair of a model if it is empty.
 */
@SmithyInternalApi
public final class RemoveEmptyComponents implements OpenApiMapper {
    private static final String COMPONENTS = "components";

    @Override
    public byte getOrder() {
        return 112;
    }

    @Override
    public ObjectNode updateNode(Context context, OpenApi openapi, ObjectNode node) {
        ObjectNode components = node.getObjectMember(COMPONENTS).orElse(null);

        if (components == null) {
            return node;
        }

        // Remove all component key value pairs that are empty objects.
        ObjectNode updatedComponents = components.getMembers().entrySet().stream()
                .filter(entry -> !isEmptyObject(entry.getValue()))
                .collect(ObjectNode.collect(Map.Entry::getKey, Map.Entry::getValue));

        // Remove the "components" key from the model if it's empty.
        return updatedComponents.isEmpty()
               ? node.withoutMember(COMPONENTS)
               : node.withMember(COMPONENTS, updatedComponents);
    }

    private static boolean isEmptyObject(Node node) {
        return node.asObjectNode().filter(ObjectNode::isEmpty).isPresent();
    }
}