Skip to content

Hide deprecated 504 responses from schema - #487

Merged
Orkuncakilkaya merged 7 commits into
mainfrom
inter-2603-remove-deprecated-responses
Oct 2, 2026
Merged

Orkuncakilkaya merged 7 commits into
mainfrom
inter-2603-remove-deprecated-responses

Conversation

@Orkuncakilkaya

Copy link
Copy Markdown
Contributor

No description provided.

@Orkuncakilkaya
Orkuncakilkaya requested a balanced review from Copilot October 2, 2026 13:43
@changeset-bot

changeset-bot Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 23c5d39

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Orkuncakilkaya Orkuncakilkaya changed the title fix: hide deprecated 504 responses from openapi Hide deprecated 504 responses from schema Oct 2, 2026
@github-actions

github-actions Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

Schema Diff vs Published Schemas

  • Generated at: 2026-10-02T14:47:00.353Z
  • Published source: https://fingerprintjs.github.io/openapi/schemas
  • Compared schemas: 8
  • Changed schemas: 0

No schema changes detected between local build output and published GitHub Pages schemas.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Pipeline-level tests are needed to protect the documented SDK compatibility guarantee.

Review effort: Balanced
Findings: 1 Medium severity

Open (1)
What changed in this PR

Hides deprecated 504 responses from documentation while preserving SDK compatibility.

Changes:

  • Adds a transformer for deprecated responses.
  • Marks two event 504 responses as deprecated.
  • Removes internal markers from SDK schemas and adds changesets/tests.
File Description
utils/​transformers/​transformSchema.ts Configures documentation and SDK pipelines.
utils/​transformers/​removeDeprecatedResponsesTransformer.ts Implements deprecated-response removal.
utils/​transformers/​removeDeprecatedResponsesTransformer.spec.ts Adds unit coverage.
schemas/​paths/​events.yaml Marks Events Search 504 as deprecated.
schemas/​paths/​event.yaml Marks Get Event 504 as deprecated.
.changeset/​deprecated-response-504-events.md Documents Get Event behavior.
.changeset/​deprecated-response-504-events-search.md Documents Events Search behavior.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread utils/transformers/removeDeprecatedResponsesTransformer.spec.ts Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The transformer behavior, SDK compatibility, schema updates, and pipeline integration are adequately tested.

Review effort: Balanced
Findings: None

Resolved since last review (1)

@Orkuncakilkaya
Orkuncakilkaya marked this pull request as ready for review October 2, 2026 13:52
@Orkuncakilkaya
Orkuncakilkaya requested a review from a team as a code owner October 2, 2026 13:52

@mcnulty-fp mcnulty-fp left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this! A few changes to make. Let me know if I can clarify my comments.

Comment thread .changeset/deprecated-response-504-events-search.md Outdated
Comment thread schemas/paths/event.yaml Outdated
Comment thread schemas/paths/events.yaml Outdated
Comment thread utils/transformers/transformSchema.ts Outdated
Comment thread utils/transformers/removeDeprecatedResponsesTransformer.spec.ts Outdated
@Orkuncakilkaya
Orkuncakilkaya force-pushed the inter-2603-remove-deprecated-responses branch from 891e99d to 715cd0a Compare October 2, 2026 14:31
mcnulty-fp
mcnulty-fp previously approved these changes Oct 2, 2026

@mcnulty-fp mcnulty-fp left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Just one nit

Comment thread utils/transformers/removeDeprecatedResponsesTransformer.ts Outdated
Co-authored-by: Dan McNulty <212590662+mcnulty-fp@users.noreply.github.com>
@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

⚠️ This PR doesn't contain any changesets. If there are user-facing changes, don't forget to run:

pnpm run changeset

to create a changeset.

@Orkuncakilkaya
Orkuncakilkaya merged commit da4fec9 into main Oct 2, 2026
6 checks passed
@Orkuncakilkaya
Orkuncakilkaya deleted the inter-2603-remove-deprecated-responses branch October 2, 2026 15:13

This branch was successfully deployed

1 active deployment
test — 23c5d397 Deployed Oct 2, 2026 by Orkuncakilkaya via Lint, build and test #1464
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.

4 participants