chore(openapi-parser): deprecate pipeline syntax #5658

hanspagel · 2025-05-15T13:25:28Z

Problem

In the README, we promote a pipeline syntax for the parser:

import { openapi } from '@scalar/openapi-parser'

const specification = …

// New pipeline …
const result = openapi()
  // loads the specification …
  .load(specification)
  // upgrades to OpenAPI 3.1 …
  .upgrade()
  // removes all internal operations …
  .filter((schema) => !schema?.['x-internal'])
  // done!
  .get()

But this adds a lot of complexity to the code base, and it hindered me a few times to change the utilities.

Solution

I’d like to get rid of it. People can just use the individual utilities. With this PR we’re marking it as @deprecated and removing it from the README.

Checklist

I’ve gone through the following:

I’ve added an explanation why this change is needed.
I’ve added a changeset (pnpm changeset).
I’ve added tests for the regression or new feature.
I’ve updated the documentation.

changeset-bot · 2025-05-15T13:25:33Z

🦋 Changeset detected

Latest commit: a3d2cab

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 12 packages

Name	Type
@scalar/openapi-parser	Patch
@scalar/fastify-api-reference	Patch
@scalar/api-client	Patch
@scalar/api-reference	Patch
@scalar/import	Patch
@scalar/mock-server	Patch
@scalar/openapi-to-markdown	Patch
@scalar/nuxt	Patch
@scalar/api-client-react	Patch
scalar-app	Patch
@scalar/aspnetcore	Patch
@scalar/api-reference-react	Patch

Not sure what this means? Click here to learn what changesets are.

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

relativeci · 2025-05-15T13:28:33Z

#9818 Bundle Size — 2.45MiB (0%).

a3d2cab(current) vs 40bad87 main#9816(baseline)

Warning

Bundle contains 6 duplicate packages – View duplicate packages

Bundle metrics no changes

	Current #9818	Baseline #9816
Initial JS	`2.45MiB`	`2.45MiB`
Initial CSS	`0B`	`0B`
Cache Invalidation	`0%`	`100%`
Chunks	`1`	`1`
Assets	`1`	`1`
Modules	`1487`	`1487`
Duplicate Modules	`0`	`0`
Duplicate Code	`0%`	`0%`
Packages	`172`	`172`
Duplicate Packages	`6`	`6`