software.amazon.smithy.openapi.fromsmithy.mappers.OpenApiJsonSubstitutions 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 java.util.logging.Logger;
import software.amazon.smithy.build.JsonSubstitutions;
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;

/**
 * Substitutes JSON string values using the mapping defined in
 * {@code openapi.substitutions}.
 */
@SmithyInternalApi
public final class OpenApiJsonSubstitutions implements OpenApiMapper {
    private static final Logger LOGGER = Logger.getLogger(OpenApiJsonSubstitutions.class.getName());

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

    @Override
    public ObjectNode updateNode(Context context, OpenApi openapi, ObjectNode node) {
        Map substitutions = context.getConfig().getSubstitutions();

        if (substitutions.isEmpty()) {
            return node;
        }

        LOGGER.warning("Using `substitutions` is discouraged. DO NOT use placeholders in your Smithy model "
                       + "for properties that are used by other tools like SDKs or service frameworks; "
                       + "placeholders should only ever be used in models for metadata that is specific to "
                       + "generating OpenAPI artifacts.\n\n"
                       + "Prefer safer alternatives like `jsonAdd`");

        return JsonSubstitutions.create(substitutions).apply(node).expectObjectNode();
    }
}