Skip to main content

documents

Typed specification

Generated by the pinned ess generate --kind docs from adapters/atlassian/spec/ess. Structural validation establishes consistency; behaviour, storage and cross-record predicates remain implementation obligations.

Atlassian-owned native document representation and membership vocabulary.

connectors_atlassian.documents is one of connectors_atlassian's bounded contexts. Back to the index.

Types​

ConfluenceRestApi​

connectors_atlassian.documents.ConfluenceRestApi is one of rest_v1 and rest_v2.

ConfluenceV1Read​

connectors_atlassian.documents.ConfluenceV1Read is one of content_search, page_comments, page_get, pages_changed, space_get, space_pages and spaces_list.

ConfluenceV2Read​

connectors_atlassian.documents.ConfluenceV2Read is one of page_comments, page_get, pages_changed and space_pages.

CqlSearchSelection​

connectors_atlassian.documents.CqlSearchSelection is a record of three fields:

  • cql — String
  • limit — Integer
  • max_body_bytes — Integer

Every value satisfies (limit >= 1 and limit <= 100).

DocumentRepresentation​

connectors_atlassian.documents.DocumentRepresentation is one of confluence_storage and jira_fields_v2.

DocumentScopeKind​

connectors_atlassian.documents.DocumentScopeKind is one of confluence_space and jira_project.

Six of the types above are reached by nothing else in this system: connectors_atlassian.documents.ConfluenceRestApi, connectors_atlassian.documents.ConfluenceV1Read, connectors_atlassian.documents.ConfluenceV2Read, connectors_atlassian.documents.CqlSearchSelection, connectors_atlassian.documents.DocumentRepresentation and connectors_atlassian.documents.DocumentScopeKind. No entity, view, command, event, error or crossing names them, so it is either vocabulary something outside this specification uses or a leftover — and only a person can tell which.

Generated from connectors_atlassian v1 · model digest 5c7d172d47a33c3a8b86887d0ed8c3353afabdf24952da462a3debd8d34404c7 · contract digest slice-sha256/2:044569e19f3acbe26962ef9d02457a6de53f8f51296e90f2459cc1bc3cd1f6b8. Do not edit this file; change the specification and regenerate it with ess generate.