Changelog
Changelog is a section that contains a curated, chronologically ordered list of notable changes in Technical Documentation for each version of Codex.
2024-11-07
- Added detailed documentation for models API in Codex.
- Provided information about model structure, update, and deletion process.
2024-09-17
- Rich Content Filtering: Added the capability to filter entries based on the content of Rich Content fields, including filtering by specific elements, character count, and linked entries or media.
2024-08-06
- Added
takeOver
query param on PUT and PATCH endpoints allowing you to override existing locks on entries and automatically unlock them after updating.
2024-07-31
2024-07-10
- Infinite Scroll Pagination: Implemented a new feature in our GraphQL API that enables infinite scroll pagination using a continuation token. This enhancement allows for more efficient data loading and improved user experience when dealing with large datasets.
2024-05-15
- Next entry collection: Introduced a new field in GraphQL to retrieve the relative next entry collection based on custom filtering and sorting on top of a specific entry.
2024-04-17
- Handling Presets Between Environments: Implemented a solution to address the presets issue relating to environments. When a new environment is created, all existing presets from the main environment are copied into the new environment with the new environment ID as a prefix. When syncing environments, only newly created presets in the main environment that do not exist in the target environment are copied over, leaving the existing presets untouched.
- Custom Parameters for Uploaded Videos: Added the ability to add custom parameters for videos uploaded to the VP Player. These custom parameters can be filtered in the Assets page in the Codex Admin by providing key-value pairs. Additionally, the
media_id
custom parameter will be searchable in the search field using the value from this custom parameter from VP Player.
2024-03-18
- Codex Context API for plugins: Provide the list of active plugins in the organization context.
2024-03-05
- Plugin Support for Entry Publish: Added functionality to publish entries using plugins.
- New GraphQL string filters: Added a new GraphQL string filter in the CodexStringFilter which can be used to filter string fields with multiple starting with or ending with values in an array:
startsWithAny
orendsWithAny
.
2024-01-24
- Plugin Support for Entry Sidebar: Added functionality to support plugins on the entry sidebar.
- GraphQL Rich Content Update: The media field will be deprecated, and the media_v2 field should be used instead for rich content.
- GraphQL Vertical Video Player Support: Introduced support for vertical video players.
- GraphQL System Fields Update: Added new system field
clonedFrom
. - Improved Search Functionality: Enhanced search functionality for assets and entries for better user experience.
2023-12-04
- GraphQL Query Cache Control: Introduced cache control for GraphQL queries with a default
300 seconds
max age. - GraphQL Enhancements for Tags and Sections: Added functionality to fetch entries in Tags and Sections, with
includeChildren
parameter for Sections. - Important Update: Disabled the possibility to delete published entries.
2023-10-31
- Introduced
VersionId
field in CodexAsset. This allows for tracking different versions of an asset. - Introduced two new types in CodexAssetType:
Audio
andPodcast
. This allows for the listing of audio files and podcasts. - Introducing
CreatedAt
andUpdatedAt
fields in content system object. - Enabled authentication for both staging and production environments. This change is a follow-up to the API Key authentication introduced for the GraphQL API. Please ensure to include the API Key in all GraphQL requests as described in the authentication part of documentation.
- Introducing Hierarchical Section Filtering feature for enhanced section-based filtering, allowing for single or multi-level selection within the section fields.
2023-10-09
- Introduce Webhook errors
- Documentation on How to set up your webhook and Event Failures
- Introducing the "organization" property as part of the webhook payload
- Introducing Create Environment job for creating environments in an organization
- Introducing Sync Environments job fo automatic data synchronization between different environments
- Introducing focalPoint field for Asset object in GraphQL
- Introducing useFocalPoint argument for Asset URL resolver in Asset object in GraphQL
- Introducing Media Value URL resolver which takes into account focal points and image ratios for media fields in GraphQL
2023-10-2
- Introducing the "organization" property as part of the webhook payload.
2023-09-11
- Introducing Codex Jobs - a new feature that allows you to perform time consuming jobs in background, e.g import entries, import assets, delete content etc.
- Documentation about Import Entries Job
- Documentation about Import Assets Job
- Documentation about Delete Content Job
- Included entry status filtering in GraphQL
- Inlcuded a dynamic attrs field in Site Context in Plugins. This field is populated through Codex Admin with dynamic key/value pairs.
- Included default languageCode in Organization Context in Plugins. This field is populated manually by Codex team upon organization creation.
2023-09-05
- Introducing API Key authentication for GraphQL API
Please make sure to send the API Key as part of GraphQL requests before 1st of October 2023. Starting from this date all requests to GraphQL API without API Key will not return any result
2023-08-16
2023-08-14
Fix getting section by id when section parent does not have a path
Fix creating tag hierarchy from entry tag field when entry is published after edit.
Fix creating tag twice from entry tag field.
Fix delete entry permission check imidiatly after entry creation.
Allow list to have more than 1 same entry.
Allow update view with empty filters.
Include List object type in GraphQL
2023-04-07
Introduced a new object type resolver for Rich Content field
Included the path field resolver for section object
Included information about Codex Context API for plugins
Included information about Creating custom permissions for plugins
2023-03-10
Included the documentation for URL resolving in GraphQL
Included the ExternalId field for author object in GraphQL
2022-12-29
Included new error codes in Codex Errors documentation
Removed Media union and Video objects, all media types are now handled by CodexAsset object type.
Included the description, media and references fields for CodexSection object type.
Included Lists endpoints in Swagger documentation.
2022-12-12
Changed duration field data type from Int to Float for video assets in CodexAsset type
Renamed CodexImageTransformation to CodexAssetTransformation
Added video format delivery for video assets in CodexAsset
2022-12-05
Replaced CodexMediaType with CodexAssetType for the media field and updated PLAYLIST enum value to VIDEO_PLAYLIST in CodexAssetType enum.
Introduced Duration property in CodexAsset type.
Introduced Reference field filtering. More info here
Introduced Media field filtering. More info here
Introduced Section field filtering. More info here
Introduced Author field filtering. More info here
Introduced label filtering in Codex system input. More info here
Introduced filtering and ordering in Codex relations. More info here
Updated docs for Codex entry references schema. More info here
2022-11-28
Introduced new status for entries: Edited. Entries automatically get the Edited status when they have changes after they have been published. The Edited status is part of the Entry System object. This changes are applied to the delivery GraphQL API only when the entry is republished. You can preview this changes by using the Preview argument in GraphQL.
Enabled Rest API listing for Entries. You can test the endpoint in the API swagger.
Updated webhooks payload schema with new changes.
Included URL field type in GraphQL schema.
Included Edited status in GraphQL schema.