Skip to content

Research compact official metadata for Shopify GraphQL deprecations #2

Closed

Description

@efegokdemir

Investigate whether Shopify provides a stable, redistributable source for Admin GraphQL deprecation metadata across versioned schemas.

Success criteria:

  • cite official Shopify sources;
  • document license/redistribution constraints;
  • propose a bounded metadata format;
  • do not add a generic GraphQL validator or runtime network dependency.

Activity

  1. efegokdemir commented on Oct 22, 2026

    @efegokdemir
    MemberAuthor

    Research completed. Shopify publishes versioned Admin GraphQL references and announces deprecations with migration guidance in its versioning guide. Shopify's maintained API codegen preset documents a versioned admin-graphql-direct-proxy/<version> schema URL as a code-generation input. I found no official compact deprecation feed or downloadable versioned catalogue. A schema can identify deprecated members in one version, but does not by itself establish a verified introduction/removal version, replacement or safe static matcher; those still need changelog and reference evidence.

    Redistribution is not clear. The current API Terms define Shopify APIs to include data structures and technical documentation, and restrict copying or creating derivative works of the API or any portion without written authorisation, subject to the stated exceptions. I found no explicit grant to redistribute schema snapshots or generated metadata. This is a licensing risk assessment, not a legal opinion, so we should not bundle those materials without written permission or a clear licence review.

    I documented the evidence and decision in docs/graphql-deprecation-metadata.md, merged in PR #51. If rights become clear and a catalogue proves useful, the bounded format is API version, coordinate, status, deprecated/removed versions, replacement, official source URL and verification date—without schema definitions or copied descriptions. Review release notes and the changelog quarterly and after relevant announcements. Until then, the offline hand-maintained, source-linked rules offer clearer migration guidance at lower maintenance cost.

    This answers the acceptance criteria. Closing the issue; no schema import, runtime network dependency or general-purpose validator was added.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions