GET /api/apis/versions/{APIVersionID}/design
Returns information about the API design for the specified API version, in the form of a Swagger document.
Authorization Roles/Permissions: Must have Read permission for the resource.
This topic includes the following sections:
HTTP Method
GET
URL
https://{hostname}/api/apis/versions/{APIVersionID}/design[?][specification={specification}][&][Introspection={Boolean}]
Sample Request #1: Swagger 2.0
The example below shows a request for the API description document for the specified API. For the response, see Sample Response #1: Swagger 2.0 below.
Sample Request URL
https://{hostname}/api/apis/versions/004fcb31-eda8-481b-b5c0-4b8bb391764b.acmepaymentscorp/design
Sample request headers
Accept: */*
Sample request body
Not applicable.
Sample Request #2: GraphQL
The example below shows a request for the API description document for a GraphQL API. For the response, see Sample Response #2: GraphQL below.
Sample Request URL
https://{hostname}/api/apis/versions/1cad5826-aaaa-4248-a9be-67e51a1f0a6d.acmepaymentscorp/design?specification=graphql&Introspection=true
Sample request headers
Accept: */*
Sample request body
Not applicable.
Request Headers
For general information on request header values, refer to HTTP Request Headers.
| Header | Description |
|---|---|
| Accept |
The media type is determined by the specification. Use a generic value such as */*, specify an appropriate value for the specification you're using, or leave blank. For example:
|
| Cookie | AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies. |
| X-Csrf-Token_{fedmemberID} | The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login. |
Request Parameters
| Parameter | Parm Type | Data Type | Required | Description |
|---|---|---|---|---|
| APIVersionID | Path | string | Required | The unique ID for a specific API version. |
| specification | Query | string | Required for GraphQL otherwise optional |
The specification for the API description document. Valid values:
Note: This parameter is required for GraphQL APIs. |
| Introspection | Query | Boolean | Optional |
Determines the information returned in the response, as follows:
|
Response
If successful, this operation returns HTTP status code 200, with information about the API design.
Sample Response #1: Swagger 2.0
The sample response below shows successful completion of this operation. For the request, see Sample Request #1: Swagger 2.0 above.
Sample response headers
Status Code: 200 OK Content-Type: application/json Date: Thu, 24 Feb 2022 19:20:13 GMT
Sample response body
{
"swagger":"2.0",
"info":{
"description":"This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.",
"version":"1.0.5",
"title":"Swagger_Petstore",
"termsOfService":"http://swagger.io/terms/",
"contact":{
"email":"apiteam@swagger.io"
},
"license":{
"name":"Apache 2.0",
"url":"http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"paths":{
"/pet":{
"post":{
"tags":[
"pet"
],
"summary":"Add a new pet to the store",
"operationId":"addPet",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"in":"body",
"name":"body",
"description":"Pet object that needs to be added to the store",
"required":true,
"schema":{
"$ref":"#/definitions/Pet"
}
}
],
"responses":{
"405":{
"description":"Invalid input"
}
}
},
"put":{
"tags":[
"pet"
],
"summary":"Update an existing pet",
"operationId":"updatePet",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"in":"body",
"name":"body",
"description":"Pet object that needs to be added to the store",
"required":true,
"schema":{
"$ref":"#/definitions/Pet"
}
}
],
"responses":{
"400":{
"description":"Invalid ID supplied"
},
"404":{
"description":"Pet not found"
},
"405":{
"description":"Validation exception"
}
}
}
},
"/pet/findByStatus":{
"get":{
"tags":[
"pet"
],
"summary":"Finds Pets by status",
"description":"Multiple status values can be provided with comma separated strings",
"operationId":"findPetsByStatus",
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"status",
"in":"query",
"description":"Status values that need to be considered for filter",
"required":true,
"type":"array",
"items":{
"type":"string",
"enum":[
"available",
"pending",
"sold"
],
"default":"available"
},
"collectionFormat":"multi"
}
],
"responses":{
"200":{
"description":"successful operation",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Pet"
}
}
},
"400":{
"description":"Invalid status value"
}
}
}
},
"/pet/findByTags":{
"get":{
"tags":[
"pet"
],
"summary":"Finds Pets by tags",
"description":"Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
"operationId":"findPetsByTags",
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"tags",
"in":"query",
"description":"Tags to filter by",
"required":true,
"type":"array",
"items":{
"type":"string"
},
"collectionFormat":"multi"
}
],
"responses":{
"200":{
"description":"successful operation",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Pet"
}
}
},
"400":{
"description":"Invalid tag value"
}
},
"deprecated":true
}
},
"/pet/{petId}":{
"get":{
"tags":[
"pet"
],
"summary":"Find pet by ID",
"description":"Returns a single pet",
"operationId":"getPetById",
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"petId",
"in":"path",
"description":"ID of pet to return",
"required":true,
"type":"integer",
"format":"int64"
}
],
"responses":{
"200":{
"description":"successful operation",
"schema":{
"$ref":"#/definitions/Pet"
}
},
"400":{
"description":"Invalid ID supplied"
},
"404":{
"description":"Pet not found"
}
}
},
"post":{
"tags":[
"pet"
],
"summary":"Updates a pet in the store with form data",
"operationId":"updatePetWithForm",
"consumes":[
"application/x-www-form-urlencoded"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"petId",
"in":"path",
"description":"ID of pet that needs to be updated",
"required":true,
"type":"integer",
"format":"int64"
},
{
"name":"name",
"in":"formData",
"description":"Updated name of the pet",
"required":false,
"type":"string"
},
{
"name":"status",
"in":"formData",
"description":"Updated status of the pet",
"required":false,
"type":"string"
}
],
"responses":{
"405":{
"description":"Invalid input"
}
}
},
"delete":{
"tags":[
"pet"
],
"summary":"Deletes a pet",
"operationId":"deletePet",
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"api_key",
"in":"header",
"required":false,
"type":"string"
},
{
"name":"petId",
"in":"path",
"description":"Pet id to delete",
"required":true,
"type":"integer",
"format":"int64"
}
],
"responses":{
"400":{
"description":"Invalid ID supplied"
},
"404":{
"description":"Pet not found"
}
}
}
},
"/pet/{petId}/uploadImage":{
"post":{
"tags":[
"pet"
],
"summary":"uploads an image",
"operationId":"uploadFile",
"consumes":[
"multipart/form-data"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"petId",
"in":"path",
"description":"ID of pet to update",
"required":true,
"type":"integer",
"format":"int64"
},
{
"name":"additionalMetadata",
"in":"formData",
"description":"Additional data to pass to server",
"required":false,
"type":"string"
},
{
"name":"file",
"in":"formData",
"description":"file to upload",
"required":false,
"type":"file"
}
],
"responses":{
"200":{
"description":"successful operation",
"schema":{
"$ref":"#/definitions/ApiResponse"
}
}
}
}
},
"/store/inventory":{
"get":{
"tags":[
"store"
],
"summary":"Returns pet inventories by status",
"description":"Returns a map of status codes to quantities",
"operationId":"getInventory",
"produces":[
"application/json"
],
"responses":{
"200":{
"description":"successful operation",
"schema":{
"type":"object",
"additionalProperties":{
"type":"integer",
"format":"int32"
}
}
}
}
}
},
"/store/order":{
"post":{
"tags":[
"store"
],
"summary":"Place an order for a pet",
"operationId":"placeOrder",
"consumes":[
"application/json"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"in":"body",
"name":"body",
"description":"order placed for purchasing the pet",
"required":true,
"schema":{
"$ref":"#/definitions/Order"
}
}
],
"responses":{
"200":{
"description":"successful operation",
"schema":{
"$ref":"#/definitions/Order"
}
},
"400":{
"description":"Invalid Order"
}
}
}
},
"/store/order/{orderId}":{
"get":{
"tags":[
"store"
],
"summary":"Find purchase order by ID",
"description":"For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions",
"operationId":"getOrderById",
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"orderId",
"in":"path",
"description":"ID of pet that needs to be fetched",
"required":true,
"type":"integer",
"format":"int64"
}
],
"responses":{
"200":{
"description":"successful operation",
"schema":{
"$ref":"#/definitions/Order"
}
},
"400":{
"description":"Invalid ID supplied"
},
"404":{
"description":"Order not found"
}
}
},
"delete":{
"tags":[
"store"
],
"summary":"Delete purchase order by ID",
"description":"For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions",
"operationId":"deleteOrder",
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"orderId",
"in":"path",
"description":"ID of the order that needs to be deleted",
"required":true,
"type":"integer",
"format":"int64"
}
],
"responses":{
"400":{
"description":"Invalid ID supplied"
},
"404":{
"description":"Order not found"
}
}
}
},
"/user":{
"post":{
"tags":[
"user"
],
"summary":"Create user",
"description":"This can only be done by the logged in user.",
"operationId":"createUser",
"consumes":[
"application/json"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"in":"body",
"name":"body",
"description":"Created user object",
"required":true,
"schema":{
"$ref":"#/definitions/User"
}
}
],
"responses":{
"default":{
"description":"successful operation"
}
}
}
},
"/user/createWithArray":{
"post":{
"tags":[
"user"
],
"summary":"Creates list of users with given input array",
"operationId":"createUsersWithArrayInput",
"consumes":[
"application/json"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"in":"body",
"name":"body",
"description":"List of user object",
"required":true,
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/User"
}
}
}
],
"responses":{
"default":{
"description":"successful operation"
}
}
}
},
"/user/createWithList":{
"post":{
"tags":[
"user"
],
"summary":"Creates list of users with given input array",
"operationId":"createUsersWithListInput",
"consumes":[
"application/json"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"in":"body",
"name":"body",
"description":"List of user object",
"required":true,
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/User"
}
}
}
],
"responses":{
"default":{
"description":"successful operation"
}
}
}
},
"/user/login":{
"get":{
"tags":[
"user"
],
"summary":"Logs user into the system",
"operationId":"loginUser",
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"username",
"in":"query",
"description":"The user name for login",
"required":true,
"type":"string"
},
{
"name":"password",
"in":"query",
"description":"The password for login in clear text",
"required":true,
"type":"string"
}
],
"responses":{
"200":{
"description":"successful operation",
"headers":{
"X-Rate-Limit":{
"type":"integer",
"format":"int32",
"description":"calls per hour allowed by the user"
},
"X-Expires-After":{
"type":"string",
"format":"date-time",
"description":"date in UTC when token expires"
}
},
"schema":{
"type":"string"
}
},
"400":{
"description":"Invalid username/password supplied"
}
}
}
},
"/user/logout":{
"get":{
"tags":[
"user"
],
"summary":"Logs out current logged in user session",
"operationId":"logoutUser",
"produces":[
"application/json",
"application/xml"
],
"responses":{
"default":{
"description":"successful operation"
}
}
}
},
"/user/{username}":{
"get":{
"tags":[
"user"
],
"summary":"Get user by user name",
"operationId":"getUserByName",
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"username",
"in":"path",
"description":"The name that needs to be fetched. Use user1 for testing. ",
"required":true,
"type":"string"
}
],
"responses":{
"200":{
"description":"successful operation",
"schema":{
"$ref":"#/definitions/User"
}
},
"400":{
"description":"Invalid username supplied"
},
"404":{
"description":"User not found"
}
}
},
"put":{
"tags":[
"user"
],
"summary":"Updated user",
"description":"This can only be done by the logged in user.",
"operationId":"updateUser",
"consumes":[
"application/json"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"username",
"in":"path",
"description":"name that need to be updated",
"required":true,
"type":"string"
},
{
"in":"body",
"name":"body",
"description":"Updated user object",
"required":true,
"schema":{
"$ref":"#/definitions/User"
}
}
],
"responses":{
"400":{
"description":"Invalid user supplied"
},
"404":{
"description":"User not found"
}
}
},
"delete":{
"tags":[
"user"
],
"summary":"Delete user",
"description":"This can only be done by the logged in user.",
"operationId":"deleteUser",
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"username",
"in":"path",
"description":"The name that needs to be deleted",
"required":true,
"type":"string"
}
],
"responses":{
"400":{
"description":"Invalid username supplied"
},
"404":{
"description":"User not found"
}
}
}
}
},
"definitions":{
"Order":{
"type":"object",
"properties":{
"id":{
"type":"integer",
"format":"int64"
},
"petId":{
"type":"integer",
"format":"int64"
},
"quantity":{
"type":"integer",
"format":"int32"
},
"shipDate":{
"type":"string",
"format":"date-time"
},
"status":{
"type":"string",
"description":"Order Status",
"enum":[
"placed",
"approved",
"delivered"
]
},
"complete":{
"type":"boolean"
}
},
"xml":{
"name":"Order"
}
},
"Category":{
"type":"object",
"properties":{
"id":{
"type":"integer",
"format":"int64"
},
"name":{
"type":"string"
}
},
"xml":{
"name":"Category"
}
},
"User":{
"type":"object",
"properties":{
"id":{
"type":"integer",
"format":"int64"
},
"username":{
"type":"string"
},
"firstName":{
"type":"string"
},
"lastName":{
"type":"string"
},
"email":{
"type":"string"
},
"password":{
"type":"string"
},
"phone":{
"type":"string"
},
"userStatus":{
"type":"integer",
"format":"int32",
"description":"User Status"
}
},
"xml":{
"name":"User"
}
},
"Tag":{
"type":"object",
"properties":{
"id":{
"type":"integer",
"format":"int64"
},
"name":{
"type":"string"
}
},
"xml":{
"name":"Tag"
}
},
"ApiResponse":{
"type":"object",
"properties":{
"code":{
"type":"integer",
"format":"int32"
},
"type":{
"type":"string"
},
"message":{
"type":"string"
}
}
},
"Pet":{
"type":"object",
"required":[
"name",
"photoUrls"
],
"properties":{
"id":{
"type":"integer",
"format":"int64"
},
"category":{
"$ref":"#/definitions/Category"
},
"name":{
"type":"string",
"example":"doggie"
},
"photoUrls":{
"type":"array",
"xml":{
"wrapped":true
},
"items":{
"type":"string",
"xml":{
"name":"photoUrl"
}
}
},
"tags":{
"type":"array",
"xml":{
"wrapped":true
},
"items":{
"xml":{
"name":"tag"
},
"$ref":"#/definitions/Tag"
}
},
"status":{
"type":"string",
"description":"pet status in the store",
"enum":[
"available",
"pending",
"sold"
]
}
},
"xml":{
"name":"Pet"
}
}
},
"tags":[
{
"name":"pet",
"description":"Everything about your Pets",
"externalDocs":{
"url":"http://swagger.io"
}
},
{
"name":"store",
"description":"Access to Petstore orders"
},
{
"name":"user",
"description":"Operations about user",
"externalDocs":{
"url":"http://swagger.io"
}
}
]
}
Sample Response #2: GraphQL
The sample response below shows successful completion of this operation. For the request, see Sample Request #2: GraphQL above.
This section includes two response body examples for the same API call, with and without the optional Introspection parameter:
- Sample response body #2-1: GraphQL response with Introspection=false, returns GraphQL schema data (text/plain)
- Sample response body #2-2: GraphQL response with Introspection=true, returns introspection data for the schema (application/json)
Sample response headers: GraphQL
Status Code: 200 OK Content-Type: */* Date: Thu, 24 Feb 2022 16:13:54 GMT
Sample response body #2-1: GraphQL response with Introspection=false, returns GraphQL schema data (text/plain)
"Directs the executor to include this field or fragment only when the `if` argument is true"
directive @include(
"Included when true."
if: Boolean!
) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
"Directs the executor to skip this field or fragment when the `if`'argument is true."
directive @skip(
"Skipped when true."
if: Boolean!
) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
"Marks the field or enum value as deprecated"
directive @deprecated(
"The reason for the deprecation"
reason: String = "No longer supported"
) on FIELD_DEFINITION | ARGUMENT_DEFINITION | ENUM_VALUE | INPUT_FIELD_DEFINITION
"Exposes a URL that specifies the behaviour of this scalar."
directive @specifiedBy(
"The URL that specifies the behaviour of this scalar."
url: String!
) on SCALAR
type Continent {
code: ID!
countries: [Country!]!
name: String!
}
type Country {
capital: String
code: ID!
continent: Continent!
currency: String
emoji: String!
emojiU: String!
languages: [Language!]!
name: String!
native: String!
phone: String!
states: [State!]!
}
type Language {
code: ID!
name: String
native: String
rtl: Boolean!
}
type Query {
continent(code: ID!): Continent
continents(filter: ContinentFilterInput): [Continent!]!
countries(filter: CountryFilterInput): [Country!]!
country(code: ID!): Country
language(code: ID!): Language
languages(filter: LanguageFilterInput): [Language!]!
}
type State {
code: String
country: Country!
name: String!
}
enum CacheControlScope {
PRIVATE
PUBLIC
}
input ContinentFilterInput {
code: StringQueryOperatorInput
}
input CountryFilterInput {
code: StringQueryOperatorInput
continent: StringQueryOperatorInput
currency: StringQueryOperatorInput
}
input LanguageFilterInput {
code: StringQueryOperatorInput
}
input StringQueryOperatorInput {
eq: String
glob: String
in: [String]
ne: String
nin: [String]
regex: String
}
Sample response body #2-2: GraphQL response with Introspection=true, returns introspection data for the schema (application/json)
{
"data":{
"__schema":{
"queryType":{
"name":"Query"
},
"mutationType":null,
"subscriptionType":null,
"types":[
{
"kind":"SCALAR",
"name":"Boolean",
"description":"Built-in Boolean",
"fields":null,
"inputFields":null,
"interfaces":null,
"enumValues":null,
"possibleTypes":null
},
{
"kind":"ENUM",
"name":"CacheControlScope",
"description":null,
"fields":null,
"inputFields":null,
"interfaces":null,
"enumValues":[
{
"name":"PRIVATE",
"description":null,
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"PUBLIC",
"description":null,
"isDeprecated":false,
"deprecationReason":null
}
],
"possibleTypes":null
},
{
"kind":"OBJECT",
"name":"Continent",
"description":null,
"fields":[
{
"name":"code",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"ID",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"countries",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"Country",
"ofType":null
}
}
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"name",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"String",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
}
],
"inputFields":null,
"interfaces":[
],
"enumValues":null,
"possibleTypes":null
},
{
"kind":"INPUT_OBJECT",
"name":"ContinentFilterInput",
"description":null,
"fields":null,
"inputFields":[
{
"name":"code",
"description":null,
"type":{
"kind":"INPUT_OBJECT",
"name":"StringQueryOperatorInput",
"ofType":null
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
}
],
"interfaces":null,
"enumValues":null,
"possibleTypes":null
},
{
"kind":"OBJECT",
"name":"Country",
"description":null,
"fields":[
{
"name":"capital",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"code",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"ID",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"continent",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"Continent",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"currency",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"emoji",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"String",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"emojiU",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"String",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"languages",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"Language",
"ofType":null
}
}
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"name",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"String",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"native",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"String",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"phone",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"String",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"states",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"State",
"ofType":null
}
}
}
},
"isDeprecated":false,
"deprecationReason":null
}
],
"inputFields":null,
"interfaces":[
],
"enumValues":null,
"possibleTypes":null
},
{
"kind":"INPUT_OBJECT",
"name":"CountryFilterInput",
"description":null,
"fields":null,
"inputFields":[
{
"name":"code",
"description":null,
"type":{
"kind":"INPUT_OBJECT",
"name":"StringQueryOperatorInput",
"ofType":null
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"continent",
"description":null,
"type":{
"kind":"INPUT_OBJECT",
"name":"StringQueryOperatorInput",
"ofType":null
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"currency",
"description":null,
"type":{
"kind":"INPUT_OBJECT",
"name":"StringQueryOperatorInput",
"ofType":null
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
}
],
"interfaces":null,
"enumValues":null,
"possibleTypes":null
},
{
"kind":"SCALAR",
"name":"ID",
"description":"Built-in ID",
"fields":null,
"inputFields":null,
"interfaces":null,
"enumValues":null,
"possibleTypes":null
},
{
"kind":"OBJECT",
"name":"Language",
"description":null,
"fields":[
{
"name":"code",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"ID",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"name",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"native",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"rtl",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"Boolean",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
}
],
"inputFields":null,
"interfaces":[
],
"enumValues":null,
"possibleTypes":null
},
{
"kind":"INPUT_OBJECT",
"name":"LanguageFilterInput",
"description":null,
"fields":null,
"inputFields":[
{
"name":"code",
"description":null,
"type":{
"kind":"INPUT_OBJECT",
"name":"StringQueryOperatorInput",
"ofType":null
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
}
],
"interfaces":null,
"enumValues":null,
"possibleTypes":null
},
{
"kind":"OBJECT",
"name":"Query",
"description":null,
"fields":[
{
"name":"continent",
"description":null,
"args":[
{
"name":"code",
"description":null,
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"ID",
"ofType":null
}
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
}
],
"type":{
"kind":"OBJECT",
"name":"Continent",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"country",
"description":null,
"args":[
{
"name":"code",
"description":null,
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"ID",
"ofType":null
}
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
}
],
"type":{
"kind":"OBJECT",
"name":"Country",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"languages",
"description":null,
"args":[
{
"name":"filter",
"description":null,
"type":{
"kind":"INPUT_OBJECT",
"name":"LanguageFilterInput",
"ofType":null
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
}
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"Language",
"ofType":null
}
}
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"language",
"description":null,
"args":[
{
"name":"code",
"description":null,
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"ID",
"ofType":null
}
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
}
],
"type":{
"kind":"OBJECT",
"name":"Language",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"countries",
"description":null,
"args":[
{
"name":"filter",
"description":null,
"type":{
"kind":"INPUT_OBJECT",
"name":"CountryFilterInput",
"ofType":null
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
}
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"Country",
"ofType":null
}
}
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"continents",
"description":null,
"args":[
{
"name":"filter",
"description":null,
"type":{
"kind":"INPUT_OBJECT",
"name":"ContinentFilterInput",
"ofType":null
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
}
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"Continent",
"ofType":null
}
}
}
},
"isDeprecated":false,
"deprecationReason":null
}
],
"inputFields":null,
"interfaces":[
],
"enumValues":null,
"possibleTypes":null
},
{
"kind":"OBJECT",
"name":"State",
"description":null,
"fields":[
{
"name":"code",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"country",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"Country",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"name",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"String",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
}
],
"inputFields":null,
"interfaces":[
],
"enumValues":null,
"possibleTypes":null
},
{
"kind":"SCALAR",
"name":"String",
"description":"Built-in String",
"fields":null,
"inputFields":null,
"interfaces":null,
"enumValues":null,
"possibleTypes":null
},
{
"kind":"INPUT_OBJECT",
"name":"StringQueryOperatorInput",
"description":null,
"fields":null,
"inputFields":[
{
"name":"eq",
"description":null,
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"glob",
"description":null,
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"in",
"description":null,
"type":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"String",
"ofType":null
}
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"ne",
"description":null,
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"nin",
"description":null,
"type":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"String",
"ofType":null
}
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"regex",
"description":null,
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
}
],
"interfaces":null,
"enumValues":null,
"possibleTypes":null
},
{
"kind":"OBJECT",
"name":"__Directive",
"description":null,
"fields":[
{
"name":"name",
"description":"The __Directive type represents a Directive that a server supports.",
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"String",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"description",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"isRepeatable",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"Boolean",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"locations",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"ENUM",
"name":"__DirectiveLocation",
"ofType":null
}
}
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"args",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"__InputValue",
"ofType":null
}
}
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"onOperation",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"Boolean",
"ofType":null
},
"isDeprecated":true,
"deprecationReason":"Use `locations`."
},
{
"name":"onFragment",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"Boolean",
"ofType":null
},
"isDeprecated":true,
"deprecationReason":"Use `locations`."
},
{
"name":"onField",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"Boolean",
"ofType":null
},
"isDeprecated":true,
"deprecationReason":"Use `locations`."
}
],
"inputFields":null,
"interfaces":[
],
"enumValues":null,
"possibleTypes":null
},
{
"kind":"ENUM",
"name":"__DirectiveLocation",
"description":"An enum describing valid locations where a directive can be placed",
"fields":null,
"inputFields":null,
"interfaces":null,
"enumValues":[
{
"name":"QUERY",
"description":"Indicates the directive is valid on queries.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"MUTATION",
"description":"Indicates the directive is valid on mutations.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"SUBSCRIPTION",
"description":"Indicates the directive is valid on subscriptions.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"FIELD",
"description":"Indicates the directive is valid on fields.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"FRAGMENT_DEFINITION",
"description":"Indicates the directive is valid on fragment definitions.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"FRAGMENT_SPREAD",
"description":"Indicates the directive is valid on fragment spreads.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"INLINE_FRAGMENT",
"description":"Indicates the directive is valid on inline fragments.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"VARIABLE_DEFINITION",
"description":"Indicates the directive is valid on variable definitions.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"SCHEMA",
"description":"Indicates the directive is valid on a schema SDL definition.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"SCALAR",
"description":"Indicates the directive is valid on a scalar SDL definition.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"OBJECT",
"description":"Indicates the directive is valid on an object SDL definition.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"FIELD_DEFINITION",
"description":"Indicates the directive is valid on a field SDL definition.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"ARGUMENT_DEFINITION",
"description":"Indicates the directive is valid on a field argument SDL definition.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"INTERFACE",
"description":"Indicates the directive is valid on an interface SDL definition.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"UNION",
"description":"Indicates the directive is valid on an union SDL definition.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"ENUM",
"description":"Indicates the directive is valid on an enum SDL definition.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"ENUM_VALUE",
"description":"Indicates the directive is valid on an enum value SDL definition.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"INPUT_OBJECT",
"description":"Indicates the directive is valid on an input object SDL definition.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"INPUT_FIELD_DEFINITION",
"description":"Indicates the directive is valid on an input object field SDL definition.",
"isDeprecated":false,
"deprecationReason":null
}
],
"possibleTypes":null
},
{
"kind":"OBJECT",
"name":"__EnumValue",
"description":null,
"fields":[
{
"name":"name",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"String",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"description",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"isDeprecated",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"Boolean",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"deprecationReason",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
}
],
"inputFields":null,
"interfaces":[
],
"enumValues":null,
"possibleTypes":null
},
{
"kind":"OBJECT",
"name":"__Field",
"description":null,
"fields":[
{
"name":"name",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"String",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"description",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"args",
"description":null,
"args":[
{
"name":"includeDeprecated",
"description":null,
"type":{
"kind":"SCALAR",
"name":"Boolean",
"ofType":null
},
"defaultValue":"false",
"isDeprecated":false,
"deprecationReason":null
}
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"__InputValue",
"ofType":null
}
}
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"type",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"__Type",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"isDeprecated",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"Boolean",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"deprecationReason",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
}
],
"inputFields":null,
"interfaces":[
],
"enumValues":null,
"possibleTypes":null
},
{
"kind":"OBJECT",
"name":"__InputValue",
"description":null,
"fields":[
{
"name":"name",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"String",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"description",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"type",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"__Type",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"defaultValue",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"isDeprecated",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"Boolean",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"deprecationReason",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
}
],
"inputFields":null,
"interfaces":[
],
"enumValues":null,
"possibleTypes":null
},
{
"kind":"OBJECT",
"name":"__Schema",
"description":"A GraphQL Introspection defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, the entry points for query, mutation, and subscription operations.",
"fields":[
{
"name":"description",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"types",
"description":"A list of all types supported by this server.",
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"__Type",
"ofType":null
}
}
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"queryType",
"description":"The type that query operations will be rooted at.",
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"__Type",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"mutationType",
"description":"If this server supports mutation, the type that mutation operations will be rooted at.",
"args":[
],
"type":{
"kind":"OBJECT",
"name":"__Type",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"directives",
"description":"'A list of all directives supported by this server.",
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"__Directive",
"ofType":null
}
}
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"subscriptionType",
"description":"'If this server support subscription, the type that subscription operations will be rooted at.",
"args":[
],
"type":{
"kind":"OBJECT",
"name":"__Type",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
}
],
"inputFields":null,
"interfaces":[
],
"enumValues":null,
"possibleTypes":null
},
{
"kind":"OBJECT",
"name":"__Type",
"description":null,
"fields":[
{
"name":"kind",
"description":null,
"args":[
],
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"ENUM",
"name":"__TypeKind",
"ofType":null
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"name",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"description",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"fields",
"description":null,
"args":[
{
"name":"includeDeprecated",
"description":null,
"type":{
"kind":"SCALAR",
"name":"Boolean",
"ofType":null
},
"defaultValue":"false",
"isDeprecated":false,
"deprecationReason":null
}
],
"type":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"__Field",
"ofType":null
}
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"interfaces",
"description":null,
"args":[
],
"type":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"__Type",
"ofType":null
}
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"possibleTypes",
"description":null,
"args":[
],
"type":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"__Type",
"ofType":null
}
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"enumValues",
"description":null,
"args":[
{
"name":"includeDeprecated",
"description":null,
"type":{
"kind":"SCALAR",
"name":"Boolean",
"ofType":null
},
"defaultValue":"false",
"isDeprecated":false,
"deprecationReason":null
}
],
"type":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"__EnumValue",
"ofType":null
}
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"inputFields",
"description":null,
"args":[
{
"name":"includeDeprecated",
"description":null,
"type":{
"kind":"SCALAR",
"name":"Boolean",
"ofType":null
},
"defaultValue":"false",
"isDeprecated":false,
"deprecationReason":null
}
],
"type":{
"kind":"LIST",
"name":null,
"ofType":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"OBJECT",
"name":"__InputValue",
"ofType":null
}
}
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"ofType",
"description":null,
"args":[
],
"type":{
"kind":"OBJECT",
"name":"__Type",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"specifiedByUrl",
"description":null,
"args":[
],
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"isDeprecated":false,
"deprecationReason":null
}
],
"inputFields":null,
"interfaces":[
],
"enumValues":null,
"possibleTypes":null
},
{
"kind":"ENUM",
"name":"__TypeKind",
"description":"An enum describing what kind of type a given __Type is",
"fields":null,
"inputFields":null,
"interfaces":null,
"enumValues":[
{
"name":"SCALAR",
"description":"Indicates this type is a scalar. 'specifiedByUrl' is a valid field",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"OBJECT",
"description":"Indicates this type is an object. `fields` and `interfaces` are valid fields.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"INTERFACE",
"description":"Indicates this type is an interface. `fields` and `possibleTypes` are valid fields.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"UNION",
"description":"Indicates this type is a union. `possibleTypes` is a valid field.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"ENUM",
"description":"Indicates this type is an enum. `enumValues` is a valid field.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"INPUT_OBJECT",
"description":"Indicates this type is an input object. `inputFields` is a valid field.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"LIST",
"description":"Indicates this type is a list. `ofType` is a valid field.",
"isDeprecated":false,
"deprecationReason":null
},
{
"name":"NON_NULL",
"description":"Indicates this type is a non-null. `ofType` is a valid field.",
"isDeprecated":false,
"deprecationReason":null
}
],
"possibleTypes":null
}
],
"directives":[
{
"name":"include",
"description":"Directs the executor to include this field or fragment only when the `if` argument is true",
"locations":[
"FIELD",
"FRAGMENT_SPREAD",
"INLINE_FRAGMENT"
],
"args":[
{
"name":"if",
"description":"Included when true.",
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"Boolean",
"ofType":null
}
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
}
],
"isRepeatable":false
},
{
"name":"skip",
"description":"Directs the executor to skip this field or fragment when the `if`'argument is true.",
"locations":[
"FIELD",
"FRAGMENT_SPREAD",
"INLINE_FRAGMENT"
],
"args":[
{
"name":"if",
"description":"Skipped when true.",
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"Boolean",
"ofType":null
}
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
}
],
"isRepeatable":false
},
{
"name":"deprecated",
"description":"Marks the field or enum value as deprecated",
"locations":[
"FIELD_DEFINITION",
"ARGUMENT_DEFINITION",
"ENUM_VALUE",
"VARIABLE_DEFINITION"
],
"args":[
{
"name":"reason",
"description":"The reason for the deprecation",
"type":{
"kind":"SCALAR",
"name":"String",
"ofType":null
},
"defaultValue":"\"No longer supported\"",
"isDeprecated":false,
"deprecationReason":null
}
],
"isRepeatable":false
},
{
"name":"specifiedBy",
"description":"Exposes a URL that specifies the behaviour of this scalar.",
"locations":[
"SCALAR"
],
"args":[
{
"name":"url",
"description":"The URL that specifies the behaviour of this scalar.",
"type":{
"kind":"NON_NULL",
"name":null,
"ofType":{
"kind":"SCALAR",
"name":"String",
"ofType":null
}
},
"defaultValue":null,
"isDeprecated":false,
"deprecationReason":null
}
],
"isRepeatable":false
}
]
}
}
}
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type | The content-type is determined by the API version design. |
Response Body
| Name | Type | Description |
|---|---|---|
| API | API | Contains information about an API. |
Error Codes/Messages
If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.
| Item | Value |
|---|---|
| 401 | Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing. |
| 500 | An error occurred processing the call. |
More information about Akana API Platform API error messages.