Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions openapi/components/schemas/collections.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ properties:
nullable: true
description: Icon displayed in the Data Studio when working with this collection.
type: string
color:
nullable: true
description: Color of the collection's icon in the Data Studio.
type: string
format: hexcode
example: '#6644FF'
note:
nullable: true
description: Short description displayed in the Data Studio.
Expand All @@ -16,6 +22,11 @@ properties:
nullable: true
description: How items in this collection should be displayed when viewed relationally in the Data Studio.
type: string
preview_url:
nullable: true
description: URL template used for Live Preview. Supports the `{{$version}}` and `{{$preview_base_url}}` variables and any field in the collection, such as `{{$preview_base_url}}/blog/{{slug}}`.
example: https://example.com/blog/{{slug}}
type: string
hidden:
nullable: false
description: Whether or not this collection is hidden in the Data Studio.
Expand Down Expand Up @@ -73,4 +84,17 @@ properties:
nullable: false
description: Whether or not Content Versioning is enabled for this collection.
type: boolean
autosave_revision_interval:
nullable: true
description: How often, in seconds, auto-saving a content version creates a new revision. Only applies when `versioning` is enabled and `accountability` is `all`. When `null`, the `AUTOSAVE_REVISION_INTERVAL` environment variable is used.
type: number
example: 300
status:
nullable: false
description: Whether the collection is active. Inactive collections cannot be read or written through the API and return a `COLLECTION_INACTIVE` error. One of `active`, `inactive`.
type: string
enum:
- active
- inactive
example: active
x-collection: directus_collections