software.amazon.smithy.openapi.fromsmithy.mappers.UnsupportedTraits 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.List;
import java.util.Set;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.traits.Trait;
import software.amazon.smithy.openapi.OpenApiException;
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.Pair;
import software.amazon.smithy.utils.SetUtils;
import software.amazon.smithy.utils.SmithyInternalApi;

/**
 * Logs each instance of traits and features that are known to not
 * work in OpenAPI.
 */
@SmithyInternalApi
public final class UnsupportedTraits implements OpenApiMapper {
    private static final Logger LOGGER = Logger.getLogger(UnsupportedTraits.class.getName());
    private static final Set TRAITS = SetUtils.of("endpoint", "hostLabel");

    @Override
    public byte getOrder() {
        return -128;
    }

    @Override
    public void before(Context context, OpenApi.Builder builder) {
        List>> violations = context.getModel().shapes()
                .map(shape -> Pair.of(shape.getId(), TRAITS.stream()
                        .filter(trait -> shape.findTrait(trait).isPresent())
                        .collect(Collectors.toList())))
                .filter(pair -> pair.getRight().size() > 0)
                .collect(Collectors.toList());

        if (violations.isEmpty()) {
            return;
        }

        StringBuilder message = new StringBuilder(
                "Encountered unsupported Smithy traits when converting to OpenAPI:");
        violations.forEach(pair -> message.append(String.format(
                " (`%s`: [%s])", pair.getLeft(), String.join(",", pair.getRight()))));
        message.append(". While these traits may still be meaningful to clients and servers using the Smithy "
                       + "model directly, they have no direct corollary in OpenAPI and can not be included in "
                       + "the generated model.");

        if (context.getConfig().getIgnoreUnsupportedTraits()) {
            LOGGER.warning(message.toString());
        } else {
            throw new OpenApiException(message.toString());
        }
    }
}