Upgrade Guides

List all current breaking changes in the GraphQL API and how to upgrade your application.

Each deprecated field will be maintained for 6 months until we remove it definitely. Be sure to update your application before this deadline!

Stay tuned #sirius-developer!

LegacyCustomFields

backgroundMedia

Maintained until 2022-09-15

Since backgroundMedia missing contextual image information such as crops or defaultAspectRatio, we introduced a new field coverMedia which permit manipulating ImageView:

query {
node(id: "<An article ID>") {
... on Article {
legacyCustomFields {
- backgroundMedia {
- id
- internalId
- ... on Image {
- caption
- credit
- # ...
- }
- ... on Video {
- provider
- url
- # ...
- }
- ... on Snippet {
- name
- html
- # ...
- }
- }
+ coverMedia {
+ __typename
+ ... on ImageView {
+ image {
+ id
+ internalId
+ caption
+ credit
+ # ...
+ }
+ caption
+ croppings {
+ aspectRatio {
+ id
+ key
+ name
+ x
+ y
+ }
+ width
+ height
+ top
+ left
+ }
+ defaultCropping {
+ aspectRatio {
+ id
+ key
+ name
+ x
+ y
+ }
+ width
+ height
+ top
+ left
+ }
+ }
+ ... on Video {
+ id
+ internalId
+ provider
+ url
+ # ...
+ }
+ ... on Snippet {
+ id
+ internalId
+ name
+ html
+ # ...
+ }
+ }
# ...
}
}

LegacyCustomFieldsInput

backgroundMedia

Maintained until 2022-09-15

coverMedia. Input fields are still the same.

Example with updateArticle mutation:

mutation {
updateArticle(
input: {
legacyCustomFields: {
- backgroundMedia: {
+ coverMedia: {
imageView: {
imageId: ""
croppings: [
{ aspectRatioId: "", width: 0, height: 0, top: 0, left: 0 }
]
caption: ""
defaultAspectRatioId: ""
}
}
}
}
) {
id
}
}

ArticleVersion

createdAt

Maintained until 2022-12-08

Use date field instead.

Example with ArticleVersion query:

query {
node(id: "<An articleVersion ID>") {
id
internalId
... on ArticleVersion {
title
chapo
- createdAt
+ date
}
}
}
Edit this page on GitHub