com.apollographql.apollo.gradle.api.Introspection.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apollo-gradle-plugin Show documentation

Gradle plugin for generating java/kotlin classes for graphql files

There is a newer version: 4.1.0

package com.apollographql.apollo.gradle.api

import org.gradle.api.provider.MapProperty
import org.gradle.api.provider.Property

/**
 * [Introspection] represents a GraphQL endpoint and its introspection query used to retrieve a schema.
 */
interface Introspection {
  /**
   * The HTTP endpoint url
   *
   * This parameter is mandatory
   */
  val endpointUrl: Property

  /**
   * query parameters if any required to get the introspection response
   *
   * empty by default
   */
  @Deprecated("add query parameters to endpointUrl instead")
  val queryParameters: MapProperty

  /**
   * HTTP headers if any required to get the introspection response
   *
   * empty by default
   */
  val headers: MapProperty

  /**
   * The name of the sourceSet where to download the schema. By default it will be downloaded
   * in the "main" sourceSet (src/main/graphql)
   */
  val sourceSetName: Property
}