jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-25 02:17:36 -05:00
Code Issues Projects Releases Wiki Activity

Reactify graphql pages (#28547)

Browse Source
This commit is contained in:
Rachael Sewell
2022-08-03 10:51:21 -07:00
committed by GitHub
parent b5f8a6089f
commit 467459af7c
79 changed files with 5514 additions and 47987 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
content/graphql/overview/breaking-changes.md
View File

@@ -1,13 +1,13 @@
---
title: Breaking changes
intro: 'Learn about recent and upcoming breaking changes to the {% data variables.product.prodname_dotcom %} GraphQL API.'
intro: "Learn about recent and upcoming breaking changes to the {% data variables.product.prodname_dotcom %} GraphQL API."
redirect_from:
- /v4/breaking_changes
versions:
fpt: '*'
ghec: '*'
ghes: '*'
ghae: '*'
fpt: "*"
ghec: "*"
ghes: "*"
ghae: "*"
topics:
- API
---
@@ -16,25 +16,9 @@ topics:
Breaking changes are any changes that might require action from our integrators. We divide these changes into two categories:
- **Breaking:** Changes that will break existing queries to the GraphQL API. For example, removing a field would be a breaking change.
- **Dangerous:** Changes that won't break existing queries but could affect the runtime behavior of clients. Adding an enum value is an example of a dangerous change.
- **Breaking:** Changes that will break existing queries to the GraphQL API. For example, removing a field would be a breaking change.
- **Dangerous:** Changes that won't break existing queries but could affect the runtime behavior of clients. Adding an enum value is an example of a dangerous change.
We strive to provide stable APIs for our integrators. When a new feature is still evolving, we release it behind a [schema preview](/graphql/overview/schema-previews).
We'll announce upcoming breaking changes at least three months before making changes to the GraphQL schema, to give integrators time to make the necessary adjustments. Changes go into effect on the first day of a quarter (January 1st, April 1st, July 1st, or October 1st). For example, if we announce a change on January 15th, it will be made on July 1st.
{% for date in graphql.upcomingChangesForCurrentVersion %}
## Changes scheduled for {{ date[0] }}
{% for change in date[1] %}
<ul>
<li><span class="border rounded-1 m-1 p-1 {% if change.criticality == 'breaking' %}color-border-danger color-bg-danger{% else %}color-border-accent-emphasis color-bg-accent{% endif %}">{% if change.criticality == 'breaking' %}Breaking{% else %}Dangerous{% endif %}</span> A change will be made to <code>{{ change.location }}</code>.
<p><b>Description:</b> {{ change.description }}</p>
<p><b>Reason:</b> {{ change.reason }}</p>
</li>
</ul>
{% endfor %}
{% endfor %}