View Source GraphqlMarkdown.MarkdownHelpers (Graphql Markdown v0.3.1)
A set of helpers to generate proper markdown easily
Summary
Functions
Generates a code block for a GraphQL operation. Only the top-level fields returned are represented in the code block. When one of the fields returned is an object, the object's fields are not included in the code block.
Functions
@spec graphql_operation_code_block( GraphqlMarkdown.OperationDetailsHelpers.graphql_operation_details() ) :: String.t()
Generates a code block for a GraphQL operation. Only the top-level fields returned are represented in the code block. When one of the fields returned is an object, the object's fields are not included in the code block.
Example:
mutation RefreshIdToken($refreshToken: String!) {
refreshIdToken(refreshToken: $refreshToken) {
idToken
userSsoDetails {
}
}
}
In this example, the idToken
field is a scalar, so it is included in the code block.
In this example the userSsoDetails
field is an object, so its fields are not included in the code block.
@spec header(String.t(), non_neg_integer(), boolean()) :: String.t()
@spec list(String.t(), non_neg_integer(), boolean()) :: String.t()
@spec new_line() :: String.t()