Objects - Charter Docs

Model tree

DocumentsListVariables

DocumentFilter

ContentComparator

ReleaseFilter

ReleaseFilter above

DocumentFilter above

DocumentGetVariables

DocumentCreateVariables

DocumentCreateInput

DocumentUpdateVariables

DocumentUpdateInput

DocumentIdVariables

DocumentsListVariables

Variables for the documents connection.

Field	Type	Description
`first`	`integer`	How many results to return. Linear returns 50 by default. ≥ 1; ≤ 250; defaults to `50`
`after`	`string`	The `endCursor` from the previous page’s `pageInfo`, to fetch the next page.
`filter`	DocumentFilter	Narrow the documents returned.
`includeArchived`	`boolean`	Include archived documents in the results.
`orderBy`	PaginationOrderBy	Sort by ‘createdAt’ or ‘updatedAt’.

DocumentFilter

A filter over documents.

Field	Type	Description
`id`	IdComparator	Filter by document UUID.
`title`	StringComparator	Filter by title.
`slugId`	StringComparator	Filter by the document’s slug.
`creator`	UserFilter	Filter by who created the document.
`project`	ProjectFilter	Filter by the project the document belongs to.
`initiative`	InitiativeFilter	Filter by the initiative the document belongs to.
`createdAt`	DateComparator	Filter by when the document was created.
`updatedAt`	DateComparator	Filter by when the document was last updated.
`cycle`	CycleFilter	Filters that the document’s cycle must satisfy.
`issue`	IssueFilter	Filters that the document’s issue must satisfy.
`team`	TeamFilter	Filters that the document’s team must satisfy.
`owner`	UserFilter	Filters that the document’s owner must satisfy.
`searchableContent`	ContentComparator	Comparator for the document’s searchable content.
`release`	ReleaseFilter	Filters that the document’s release must satisfy.

ReleaseFilter

A filter over releases.

Field	Type	Description
`id`	IdComparator	Comparator for the identifier.
`name`	StringComparator	Comparator for the release name.

ContentComparator

Substring comparators for a searchable-content field.

Field	Type	Description
`contains`	`string`	Contains the given substring.
`notContains`	`string`	Does not contain the given substring.

DocumentGetVariables

Variables for the document query.

Field	Type	Description
`id` *	`string`	The document’s UUID, or the slug from its URL.

DocumentCreateVariables

Variables for the documentCreate mutation.

Field	Type	Description
`input` *	DocumentCreateInput	The document to create.

DocumentCreateInput

The input to documentCreate.

Field	Type	Description
`title` *	`string`	The title of the document.
`content`	`string`	The document content as markdown.
`projectId`	`string`	Related project for the document.
`initiativeId`	`string`	Related initiative for the document.
`issueId`	`string`	Related issue for the document.
`cycleId`	`string`	Related cycle for the document.
`teamId`	`string`	Related team for the document.
`ownerId`	`string`	The owner of the document.
`subscriberIds`	`string`[]	The identifiers of the users subscribing to this document.
`icon`	`string`	The icon of the document.
`color`	`string`	The color of the icon, as a hex string.
`lastAppliedTemplateId`	`string`	The ID of the last template applied to the document.
`releaseId`	`string`	Related release for the document.
`sortOrder`	`number`	The order of the item in the resources list.
`id`	`string`	The identifier in UUID v4 format. If none is provided, the backend will generate one.

DocumentUpdateVariables

Variables for the documentUpdate mutation.

Field	Type	Description
`id` *	`string`	The document’s UUID.
`input` *	DocumentUpdateInput	The fields to change.

DocumentUpdateInput

The fields documentUpdate changes. All optional.

Field	Type	Description
`title`	`string`	The title of the document.
`content`	`string`	The document content as markdown. Replaces the existing content.
`projectId`	`string`	Related project for the document.
`initiativeId`	`string`	Related initiative for the document.
`issueId`	`string`	Related issue for the document.
`cycleId`	`string`	Related cycle for the document.
`teamId`	`string`	Related team for the document.
`ownerId`	`string`	The owner of the document.
`subscriberIds`	`string`[]	The identifiers of the users subscribing to this document.
`icon`	`string`	The icon of the document.
`color`	`string`	The color of the icon, as a hex string.
`trashed`	`boolean`	Whether the document has been trashed.
`lastAppliedTemplateId`	`string`	The ID of the last template applied to the document.
`releaseId`	`string`	Related release for the document.
`sortOrder`	`number`	The order of the item in the resources list.
`hiddenAt`	`string`	The time at which the document was hidden, as an ISO 8601 timestamp. This schema cannot send null to unhide — absent means unchanged.

DocumentIdVariables

Variables for the document mutations that take only an id.

Field	Type	Description
`id` *	`string`	The document’s UUID.

​Model tree

​DocumentsListVariables

​DocumentFilter

​ReleaseFilter

​ContentComparator

​DocumentGetVariables

​DocumentCreateVariables

​DocumentCreateInput

​DocumentUpdateVariables

​DocumentUpdateInput

​DocumentIdVariables

Model tree

DocumentsListVariables

DocumentFilter

ReleaseFilter

ContentComparator

DocumentGetVariables

DocumentCreateVariables

DocumentCreateInput

DocumentUpdateVariables

DocumentUpdateInput

DocumentIdVariables