Skip to content

Collection

Classes

Permission

Bases: str, enum.Enum

Available permission options for collections and documents

Collection pydantic-model

Bases: pydantic.BaseModel

Represents a collection of documents in the system.

Collections are used to organize documents into groups with shared permissions and settings. They appear in the sidebar navigation.

Fields:

  • id (uuid.UUID)
  • url_id (str)
  • name (str)
  • description (typing.Optional[str])
  • sort (typing.Optional[outline_wiki_api.models.response.Sort])
  • index (str)
  • color (typing.Optional[str])
  • icon (typing.Optional[str])
  • permission (typing.Optional[outline_wiki_api.models.response.Permission])
  • sharing (bool)
  • created_at (datetime.datetime)
  • updated_at (datetime.datetime)
  • deleted_at (typing.Optional[datetime.datetime])
  • archived_at (typing.Optional[datetime.datetime])
  • archived_by (typing.Optional[outline_wiki_api.models.user.User])

Attributes

permission = None pydantic-field

Access permissions for this collection

CollectionNavigationResponse pydantic-model

Bases: outline_wiki_api.models.response.Response

Fields:

  • status (int)
  • ok (bool)
  • pagination (typing.Optional[outline_wiki_api.models.response.Pagination])
  • policies (typing.Optional[typing.List[outline_wiki_api.models.response.Policy]])
  • data (typing.List[outline_wiki_api.models.collection.NavigationNode])

CollectionListResponse pydantic-model

Bases: outline_wiki_api.models.response.Response

Fields:

  • status (int)
  • ok (bool)
  • pagination (typing.Optional[outline_wiki_api.models.response.Pagination])
  • policies (typing.Optional[typing.List[outline_wiki_api.models.response.Policy]])
  • data (typing.Optional[typing.List[outline_wiki_api.models.collection.Collection]])

CollectionUserResponse pydantic-model

Bases: outline_wiki_api.models.response.Response

Fields: