The annotation to configure a GraphQL service.


ServiceConfig

GraphqlServiceConfig

The GraphQL context object used to pass the meta information between resolvers.


init

Sets a given value for a given key in the GraphQL context.



'key

string

value

Retrieves a value using the given key from the GraphQL context.



The value if the key is present in the context, a `graphql:Error` otherwise


Removes a value using the given key from the GraphQL context.



remove

Context

The [Ballerina](https://ballerina.io/) generic client for GraphQL(https://graphql.org/) APIs.


Gets invoked to initialize the `connector`.



serviceUrl

The configurations to be used when initializing the `connector`


clientConfig

ClientConfiguration

An error at the failure of client initialization


ClientError

Executes a GraphQL document and data binds the GraphQL response to a record with data and extensions 
which is a subtype of GenericResponse.



executeWithType

The GraphQL document. It can include queries & mutations. 
For example `query OperationName($code:ID!) {country(code:$code) {name}}`.


document

The GraphQL variables. For example `{"code": "<variable_value>"}`.


variables

The GraphQL operation name. If a request has two or more operations, then each operation must have a name. 
A request can only execute one operation, so you must also include the operation name to execute.


operationName

The GraphQL API headers to execute each query 


headers

The payload, which is expected to be returned after data binding. For example 
`type CountryByCodeResponse record {| map<json?> extensions?; record {| record{|string name;|}? country; |} data;`


targetType

The GraphQL response or a `graphql:ClientError` if failed to execute the query


Executes a GraphQL document and data binds the GraphQL response to a record with data, extensions and errors 
which is a subtype of GenericResponseWithErrors.



execute

The GraphQL document. It can include queries & mutations. 
For example `query countryByCode($code:ID!) {country(code:$code) {name}}`.


The payload (`GenericResponseWithErrors`), which is expected to be returned after data binding. For example 
`type CountryByCodeResponse record {| map<json?> extensions?; record {| record{|string name;|}? country; |} data; ErrorDetail[] errors?; |};`


Client

The prefix used to denote the Basic authentication scheme.


AUTH_SCHEME_BASIC

The prefix used to denote the Bearer authentication scheme.


AUTH_SCHEME_BEARER

Represents the authentication error type.


Error

AuthnError

Represents the authorization error type.


AuthzError

Represents GraphQL client related generic errors.


RequestError

ServerError

Represents any error related to the Ballerina GraphQL module.


Represents GraphQL client side or network level errors.


anydata

body

Represents GraphQL API response during GraphQL API server side errors.


json

data

ErrorDetail

errors

extensions

Invoked during the initialization of a `graphql:Listener`. Either an `http:Listner` or a port number must be
provided to initialize the listener.



An `http:Listener` or a port number to listen to the GraphQL service endpoint


listenTo

The additional configurations for the GraphQL listener


configuration

ListenerConfiguration

A `graphql:Error` if the listener initialization is failed or else `()`


Attaches the provided service to the Listener.



attach

The `graphql:Service` object to attach to the listener


Service

name

A `graphql:Error` if an error occurred during the service-attaching process or the schema
generation process or else `()`


Detaches the provided service from the Listener.



detach

The service to be detached from the listener


A `graphql:Error` if an error occurred during the service detaching process or else `()`


'start

A `graphql:Error`, if an error occurred during the service starting process, otherwise nil


Gracefully stops the graphql listener. Already accepted requests will be served before the connection closure.



gracefulStop

A `graphql:Error`, if an error occurred during the service stopping process, otherwise nil


Stops the service listener immediately.



immediateStop

A `graphql:Error` if an error occurred during the service stopping process or else `()`


Listener

Represent CORS configurations for internal HTTP service


The array of allowed headers by the service

allowHeaders

The array of allowed methods by the service

allowMethods

The array of origins with which the response is shared by the service

allowOrigins

The allowlisted headers, which clients are allowed to access

exposeHeaders

Specifies whether credentials are required to access the service

allowCredentials

The maximum duration to cache the preflight from client side

maxAge

CorsConfig

Represents the details of an error occurred during parsing, validating, or executing a GraphQL document.


message

The locations in the GraphQL document related to the error

locations

path

Represents file user store configurations for Basic Auth authentication.


FileUserStoreConfig

Represents the auth annotation for file user store configurations with scopes.



File user store configurations for Basic Auth authentication


fileUserStoreConfig

scopes

FileUserStoreConfigWithScopes

Represents the target type binding record with data and extensions of a GraphQL response for `executeWithType` method.



Meta information on protocol extensions from the GraphQL server


The requested data from the GraphQL server


GenericResponse

Represents the target type binding record with data, extensions and errors of a GraphQL response for `execute` method.



The errors occurred (if present) while processing the GraphQL request.


GenericResponseWithErrors

Represent GraphiQL client configurations



enable

boolean

Graphiql

Provides a set of configurations for the GraphQL service.



maxQueryDepth

auth

ListenerAuthConfig

Function to initialize the context. If not provided, an empty context will be created


contextInit

ContextInit

The cross origin resource sharing configurations for the service


cors

graphiql

The generated schema. This is auto-generated at the compile-time


schemaString

Represents JWT validator configurations for JWT authentication.



Represents JWT validator configurations.


Expected issuer, which is mapped to the `iss`

issuer

Expected username, which is mapped to the `sub`

username

Expected audience, which is mapped to the `aud`

audience

Expected JWT ID, which is mapped to the `jti`

jwtId

Expected JWT key ID, which is mapped the `kid`

keyId

customClaims

Clock skew (in seconds) that can be used to avoid token validation failures due to clock synchronization problems

clockSkew

signatureConfig

Configurations related to the cache, which are used to store parsed JWT information

cacheConfig

ValidatorConfig

scopeKey

JwtValidatorConfig

Represents the auth annotation for JWT validator configurations with scopes.



JWT validator configurations for JWT authentication


jwtValidatorConfig

JwtValidatorConfigWithScopes

Represents LDAP user store configurations for Basic Auth authentication.


Represents the LDAP user store configurations.


domainName

connectionUrl

The username used to connect to the LDAP server

connectionName

The password used to connect to the LDAP server

connectionPassword

DN of the context or object under which the user entries are stored in the LDAP server

userSearchBase

Object class used to construct user entries

userEntryObjectClass

The attribute used for uniquely identifying a user entry

userNameAttribute

Filtering criteria used to search for a particular user entry

userNameSearchFilter

Filtering criteria for searching user entries in the LDAP server

userNameListFilter

DN of the context or object under which the group entries are stored in the LDAP server

groupSearchBase

Object class used to construct group entries

groupEntryObjectClass

The attribute used for uniquely identifying a group entry

groupNameAttribute

Filtering criteria used to search for a particular group entry

groupNameSearchFilter

Filtering criteria for searching group entries in the LDAP server

groupNameListFilter

Define the attribute, which contains the distinguished names (DN) of user objects that are there in a group

membershipAttribute

To indicate whether to cache the role list of a user

userRolesCacheEnabled

Define whether LDAP connection pooling is enabled

connectionPoolingEnabled

Connection timeout (in seconds) when making the initial LDAP connection

connectionTimeout

Reading timeout (in seconds) for LDAP operations

readTimeout

The SSL configurations for the LDAP client socket. This needs to be configured in order to communicate through LDAPs

secureSocket

LdapUserStoreConfig

This module provides APIs for connecting and interacting with GraphQL endpoints.


Object type: Service