Skip to content

Keep audited API contracts observable and aligned - #187

Merged
OziinG merged 1 commit into
mainfrom
fix/api-contract-audit-gates
Aug 19, 2026
Merged

Keep audited API contracts observable and aligned#187
OziinG merged 1 commit into
mainfrom
fix/api-contract-audit-gates

Conversation

@OziinG

@OziinG OziinG commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

What changed

  • align Shopify Admin GraphQL runtime and codegen with API version 2026-07
  • propagate a safe x-clever-client-request-id across Orders and tracking requests
  • pair sanitized app timing/status metrics with Delivery API correlation logs
  • encode tracking route-plan IDs before proxying
  • align protected customer data documentation with the actual read-only scope and customer.note usage
  • document the bounded observability and /perf capture contract

Why

The full API audit found version drift, incomplete cross-service correlation, and a tracking proxy URL encoding gap. These changes make request/response timing and status evidence traceable without retaining authorization headers, query strings, or protected order/customer bodies.

Impact

Shopify order and customer access remains query-only. This PR does not mutate Shopify Orders, Customers, or Fulfillment records.

Verification

  • root tests: 486 passed, 0 failed
  • app tests: 507 passed, 0 failed
  • ESLint passed
  • production builds passed at root and app scope
  • typecheck passed at root and app scope
  • public URL guard passed
  • Shopify Admin GraphQL operations validated against the schema
  • GitHub Actions CI passed

Tracking

Constraint: Shopify order and customer data remains query-only.
Rejected: Raw request/response capture | Protected customer data must not enter retained logs.
Confidence: high
Scope-risk: moderate
Directive: Keep Shopify Admin API runtime and codegen versions synchronized.
Tested: npm test; npm run lint; npm run build; npm run typecheck; npm run check:public-urls; Shopify Admin GraphQL schema validation.
Not-tested: Production iframe smoke pending post-deploy.
@OziinG
OziinG marked this pull request as ready for review August 19, 2026 05:08
@OziinG
OziinG merged commit 8aa364e into main Aug 19, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant