Conjure

Conjure Human-Readable Format

Type object
File match **/conjure/**.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/conjure/latest.json
Source https://raw.githubusercontent.com/palantir/conjure/master/conjure.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

types object
3 nested properties
conjure-imports object

A map between a namespace and a relative path to a Conjure definition file.

imports Record<string, object>

A map between a type alias and its external definition. Type aliases MUST be in PascalCase.

definitions object
3 nested properties
default-package string
objects object
errors object
services Record<string, object>

Definitions

TypesDefinition object
conjure-imports object

A map between a namespace and a relative path to a Conjure definition file.

imports Record<string, object>

A map between a type alias and its external definition. Type aliases MUST be in PascalCase.

definitions object
3 nested properties
default-package string
objects object
errors object
ExternalTypeDefinition object
base-type TypeName | ContainerType | BuiltIn
external object

References to types that are not defined within Conjure.

1 nested properties
java string

The fully qualified Java type.

ExternalImportDefinition object

References to types that are not defined within Conjure.

java string

The fully qualified Java type.

NamedTypesDefinition object
default-package string
objects object
errors object
ConjureType TypeName | ContainerType | BuiltIn
TypeName string

Named types must be in PascalCase and be unique within a package.

ContainerType string

Container types like optional, list, set and map<K, V> can be referenced using their lowercase names, where variables like T, K and V can be substituted for a Conjure named type, a built-in or more container types:

BuiltIn enum
AliasDefinition object
alias TypeName | ContainerType | BuiltIn required
safety enum
Values: "safe" "unsafe" "do-not-log"
docs string
package string
ObjectTypeDefinition object
fields Record<string, FieldDefinition | ConjureType> required
docs string
package string
FieldDefinition object
type TypeName | ContainerType | BuiltIn required
safety enum
Values: "safe" "unsafe" "do-not-log"
docs string
package string
deprecated string
UnionTypeDefinition object
union Record<string, FieldDefinition | ConjureType> required
docs string
package string
EnumTypeDefinition object
values UpperCase | EnumValueDefinition[] required
uniqueItems=true
docs string
package string
EnumValueDefinition object
value required
pattern=^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$
docs string
package string
deprecated string
ErrorDefinition object
namespace string required
pattern=^[A-Z][a-z0-9]+([A-Z][a-z0-9]+)*$
code enum required
Values: "PERMISSION_DENIED" "INVALID_ARGUMENT" "NOT_FOUND" "CONFLICT" "REQUEST_ENTITY_TOO_LARGE" "FAILED_PRECONDITION" "INTERNAL" "TIMEOUT" "CUSTOM_CLIENT" "CUSTOM_SERVER"
package string
safe-args Record<string, FieldDefinition | ConjureType>
unsafe-args Record<string, FieldDefinition | ConjureType>
docs string
ErrorCode enum
ServiceDefinition object
package string required
endpoints Record<string, object> required
name string
base-path string
default-auth enum | string
docs string
PathString string
AuthDefinition enum | string
EndpointDefinition object
http string required
pattern=^(GET|DELETE|POST|PUT) .*$
auth enum | string
returns TypeName | ContainerType | BuiltIn
errors TypeName | EndpointError[]
args Record<string, ArgumentDefinition | ConjureType>
docs string
deprecated string
tags string[]
uniqueItems=true
ArgumentDefinition object
type TypeName | ContainerType | BuiltIn required
param-id string
param-type enum
Values: "auto" "path" "body" "header" "query"
safety enum
Values: "safe" "unsafe" "do-not-log"
docs string
tags string[]
uniqueItems=true
markers string[]
uniqueItems=true
ArgumentDefinitionParamType enum
EndpointError object
error string required

Named types must be in PascalCase and be unique within a package.

pattern=^([a-zA-Z]+[.])?[A-Z][a-z0-9]+([A-Z][a-z0-9]+)*$
docs string
DocString string
LogSafety enum
UpperCase
PascalCase string