com.expediagroup.graphql.federation.directives.FieldSet.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019 Expedia, Inc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 com.expediagroup.graphql.federation.directives

import com.expediagroup.graphql.federation.types.FIELD_SET_SCALAR_TYPE
import graphql.schema.GraphQLArgument

/**
 * Annotation representing _FieldSet scalar type that is used to represent a set of fields.
 *
 * Field set can represent:
 * - single field, e.g. "id"
 * - multiple fields, e.g. "id name"
 * - nested selection sets, e.g. "id user { name }"
 *
 * @param value field set that represents a set of fields forming the key
 *
 * @see com.expediagroup.graphql.federation.types.FIELD_SET_SCALAR_TYPE
 */
annotation class FieldSet(val value: String)

internal const val FIELD_SET_ARGUMENT_NAME = "fields"

internal val FIELD_SET_ARGUMENT = GraphQLArgument.newArgument()
    .name(FIELD_SET_ARGUMENT_NAME)
    .type(FIELD_SET_SCALAR_TYPE)
    .build()