software.amazon.smithy.openapi.fromsmithy.protocols.QuerySchemaVisitor 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.protocols;

import software.amazon.smithy.jsonschema.Schema;
import software.amazon.smithy.model.shapes.CollectionShape;
import software.amazon.smithy.model.shapes.ListShape;
import software.amazon.smithy.model.shapes.MemberShape;
import software.amazon.smithy.model.shapes.SetShape;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.shapes.ShapeVisitor;
import software.amazon.smithy.model.shapes.TimestampShape;
import software.amazon.smithy.model.traits.TimestampFormatTrait;
import software.amazon.smithy.model.traits.Trait;
import software.amazon.smithy.openapi.fromsmithy.Context;

/**
 * Creates an appropriate Schema for an input query string parameter.
 *
 * @param  Type of protocol to convert.
 */
final class QuerySchemaVisitor extends ShapeVisitor.Default {
    private final Context context;
    private final Schema schema;
    private final MemberShape member;

    QuerySchemaVisitor(Context context, Schema schema, MemberShape member) {
        this.context = context;
        this.schema = schema;
        this.member = member;
    }

    @Override
    protected Schema getDefault(Shape shape) {
        return schema;
    }

    @Override
    public Schema listShape(ListShape shape) {
        return collection(shape);
    }

    @Override
    public Schema setShape(SetShape shape) {
        return collection(shape);
    }

    // Rewrite collections in case the members contain timestamps, blobs, etc.
    private Schema collection(CollectionShape collection) {
        MemberShape collectionMember = collection.getMember();
        Shape collectionTarget = context.getModel().expectShape(collectionMember.getTarget());
        // Recursively change the items schema and its targets as needed.
        Schema refSchema = context.inlineOrReferenceSchema(collectionMember);
        Schema itemsSchema = collectionTarget.accept(
                new QuerySchemaVisitor<>(context, refSchema, collectionMember));
        // Copy the collection schema, remove any $ref, and change the items.
        return schema.toBuilder()
                .ref(null)
                .type("array")
                .items(itemsSchema)
                .build();
    }

    // Query string timestamps in Smithy are date-time strings by default
    // unless overridden by the timestampFormat trait. This code grabs the
    // referenced shape and creates an inline schema that explicitly defines
    // the necessary styles.
    @Override
    public Schema timestampShape(TimestampShape shape) {
        // Use the referenced shape as-is since it defines an explicit format.
        if (member.hasTrait(TimestampFormatTrait.class)) {
            return schema;
        }

        // Synthesize a new inline shape that defines an explicit format.
        Schema originalSchema = context.getJsonSchemaConverter().convertShape(member).getRootSchema();
        return ModelUtils.convertSchemaToStringBuilder(originalSchema)
                .format("date-time")
                .build();
    }
}