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 (str | None)
• sort (outline_wiki_api.models.response.Sort | None)
• index (str)
• color (str | None)
• icon (str | None)
• permission (outline_wiki_api.models.response.Permission | None)
• sharing (bool)
• created_at (datetime.datetime)
• updated_at (datetime.datetime)
• deleted_at (datetime.datetime | None)
• archived_at (datetime.datetime | None)
• archived_by (outline_wiki_api.models.user.User | None)

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 (outline_wiki_api.models.response.Pagination | None)
• policies (list[outline_wiki_api.models.response.Policy] | None)
• data (list[outline_wiki_api.models.collection.NavigationNode])

CollectionListResponse pydantic-model

Bases: outline_wiki_api.models.response.Response

Fields:

• status (int)
• ok (bool)
• pagination (outline_wiki_api.models.response.Pagination | None)
• policies (list[outline_wiki_api.models.response.Policy] | None)
• data (list[outline_wiki_api.models.collection.Collection])

CollectionUserResponse pydantic-model

Bases: outline_wiki_api.models.response.Response

Fields:

• status (int)
• ok (bool)
• pagination (outline_wiki_api.models.response.Pagination | None)
• policies (list[outline_wiki_api.models.response.Policy] | None)
• data (outline_wiki_api.models.user.UserMembership | None)