> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/development/migrations.md).

# Migrations

Migration guides for breaking changes in the pyck API

Audience: Programmer

This section contains migration guides for breaking changes in the pyck GraphQL API. Each guide explains what changed, why it changed, and provides step-by-step instructions for updating your code.

## Available Migration Guides

| Guide                                                                            | Description                                                                     |
| -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| [Relay Connections](/development/migrations/relay-connections.md)                | All entity relationship fields now return Relay-style Connection objects        |
| [InventoryItem Data Field](/development/migrations/inventory-item-data-field.md) | The inventoryJSONData field has been removed in favor of the unified data field |

## General Migration Tips

1. **Test in Development First**: Always apply migrations to your development environment before production.
2. **Update Incrementally**: When multiple breaking changes are introduced, migrate one change at a time.
3. **Check Your Queries**: Use GraphQL introspection to verify the new schema structure before updating your queries.
4. **Update Client Libraries**: Ensure your GraphQL client libraries are compatible with the new schema.
5. **Monitor for Errors**: After deploying migrated code, monitor your application for any GraphQL errors.

## Getting Help

If you encounter issues during migration:

* Check the specific migration guide for troubleshooting tips
* Review the [GraphQL Error Handling](https://github.com/pyck-ai/docs/blob/main/development/graphql/error-handling.md) documentation
* Consult the [GraphQL Getting Started](https://github.com/pyck-ai/docs/blob/main/development/graphql/getting-started.md) guide for basics


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/development/migrations.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.