Skip to content

[Community Goal 2026] [S1] Migrate @asyncapi/openapi-schema-parser into the parser-js #326

Closed

Description

@princerajpoot20

Description

We have approval from the codeowners of openapi-schema-parser and parser-js.
More details here:
#322
asyncapi/parser-js#1194

We are proceeding with the merger.

Move @asyncapi/openapi-schema-parser into asyncapi/parser-js as packages/openapi-schema-parser/. Same npm package name and public API — no breaking change for consumers.

Action items

  • Move code into parser-js (packages/openapi-schema-parser/)
  • Update turbo.json / monorepo wiring for the new package
  • Point multi-parser at the workspace package (today it still depends on the published npm version ^3.0.4)
  • Sort out releases so @asyncapi/openapi-schema-parser publishes from parser-js
  • Add a spec for openapi-schema-parser (see below)
  • Update other relevant files as needed, such as the README.

CODEOWNERS: no change needed — all openapi-schema-parser codeowners already have full access to parser-js.

Optional: verify the first release from the monorepo publishes correctly.

Out of scope: Archiving the openapi-schema-parser repo.

Spec

The reason we are consolidating these repos — and the broader community goal of auditing — is to improve repo health and maintainability, bring on more maintainers, and eventually reduce maintainer burnout.

As part of that, we are adding specs in these repos. Specs act as a source of truth for contributors, and more importantly give AI context about the package. That should help anyone developing here, whatever approach they follow: pure vibe coding, pure spec-driven, or a mix of both.

Notes on references inside parser-js

What does need updating: packages/multi-parser/package.json currently has "@asyncapi/openapi-schema-parser": "^3.0.4" (npm). After migration it should use the local workspace package (same pattern as "@asyncapi/parser": "*"), so builds/tests resolve to packages/openapi-schema-parser instead of registry.npmjs.org.

Docs/README links that currently point at the standalone GitHub repo can be updated to the monorepo path as a follow-up.

References

Activity

  1. princerajpoot20 commented on Jul 15, 2026

    @princerajpoot20
    MemberAuthor

    I will be working on this under microgrant program.

  2. AceTheCreator commented on Jul 16, 2026

    @AceTheCreator
    Member

    @princerajpoot20, I have a few clarification questions:

    1. Browser compatibility: How does this change affect the browser module of the parser? Will it break the in-browser environments supoprt?

    2. Scope of the change: Are you moving the code into the repo as-is, with no changes to how it's used? I'm asking because the parser has Node.js dependencies, and I want to confirm the usage stays consistent with what's documented in the Custom Schema Parsers section.

    3. Terminology: When you say "migrate," what exactly do you mean? Are you deprecating the old approach, or is this purely additive?

  3. princerajpoot20 commented on Jul 16, 2026

    @princerajpoot20
    MemberAuthor

    @AceTheCreator

    1. No, this does not affect the parser browser module. We're only moving where the OpenAPI package's source code lives. We're not bundling it into the parser's browser build. OpenAPI remains a separate package, just as it is today.
    2. Yes - this is a code relocation with no change in usage. Consumers will still install @asyncapi/openapi-schema-parser and register it as documented under Custom Schema Parsers. We are moving the code as-is. only its location is changing. The functionality remains exactly the same.
    3. Migrate means moving the source code into parser-js. The package name remains the same - this is not a deprecation of the consumer approach.

    In short, nothing is changing for consumers. Everything remains exactly as it is today for them.

  4. AceTheCreator commented on Jul 16, 2026

    @AceTheCreator
    Member

    Okay. Thanks for the clarifiction @princerajpoot20

  5. aeworxet commented on Jul 29, 2026

    @aeworxet

    Microgrant Issue's service comment

    Text labels: microgrant/2026-08, microgrant/advanced, microgrant/coding
    First assignment to regular contributors: 2026-08-02 00:00:00 UTC+12:00
    End Of Life after: 2026-08-31 23:59:59 UTC-12:00

    @asyncapi/microgrant_team

    The Microgrant Program is not a Mentorship Program. The accepted level of Microgrant Program Participants is Middle/Senior.
    Regular contributors should explain in clear terms how they will approach the resolution process when expressing interest in working on this Microgrant Issue.
    References: Microgrant Program 101, Microgrant Program Rules
  6. aeworxet commented on Jul 30, 2026

    @aeworxet

    Following the expression of interest in working on this Microgrant Issue, @princerajpoot20 (githubID: 44585452) is an AsyncAPI Maintainer specified in the file https://github.com/asyncapi/community/blob/master/MAINTAINERS.yaml, so they fall under the first category in the prioritization list.

  7. aeworxet commented on Jul 30, 2026

    @aeworxet

    Microgrant Issue's Assigned Timeline

    Complexity Level Assignment Date (by GitHub) Start Date (by MP Rules) End Date (by MP Rules) Draft PR Submission Final PR Merge Start Final PR Merge End
    Advanced 2026-07-15 2026-08-03 2026-09-27 2026-08-23 2026-09-13 2026-09-27
    Please note that the dates given represent deadlines, not specific dates; so if the goal is reached sooner, it's better.
    Keep in mind the responsibility for violations of the Timeline.

    Assignee: @princerajpoot20 (githubID: 44585452)

  8. moved this to In Progress in Microgrant Programon Jul 30, 2026
  9. princerajpoot20 commented on Aug 2, 2026

    @princerajpoot20
    MemberAuthor

    PRs ready for review:
    asyncapi/parser-js#1213
    #330

  10. princerajpoot20 commented on Aug 6, 2026

    @princerajpoot20
    MemberAuthor

    https://github.com/asyncapi/parser-js/actions/runs/31102899622/attempts/1
    The release failed because we need to adjust the npm permissions accordingly. The Trusted Publishing configuration needs to be changed from the openapi-schema-parser repository to the parser-js repository for the openapi-schema-parser npm package.

  11. princerajpoot20 commented on Aug 6, 2026

    @princerajpoot20
    MemberAuthor

    Changed the permissions in NPM. parser-js repo is now in tusted publishing configuration

  12. princerajpoot20 commented on Aug 6, 2026

    @princerajpoot20
    MemberAuthor
  13. princerajpoot20 commented on Aug 6, 2026

    @princerajpoot20
    MemberAuthor

    Auth seems to be fixed after the re-run.

    We have a new error: the npm metadata shows that versions 3.0.25 and 3.0.26 were published in November 2025 and later removed from the installable list (this is because we manually removed those versions for security reasons). However, those version numbers are still blocked.

    We'll need to bump the minor version now. The version will now be 3.1.0.

  14. princerajpoot20 commented on Aug 6, 2026

    @princerajpoot20
    MemberAuthor

    Release PR to bump the minor version: asyncapi/parser-js#1220

  15. princerajpoot20 commented on Aug 6, 2026

    @princerajpoot20
    MemberAuthor
  16. princerajpoot20 commented on Aug 6, 2026

    @princerajpoot20
    MemberAuthor
  17. princerajpoot20 commented on Aug 6, 2026

    @princerajpoot20
    MemberAuthor
  18. princerajpoot20 commented on Aug 6, 2026

    @princerajpoot20
    MemberAuthor

    @aeworxet This microgrant issue has been completed.

  19. moved this from In Progress to Completed in Microgrant Programon Aug 6, 2026
  20. aeworxet commented on Aug 7, 2026

    @aeworxet

    Microgrant Issue Is Completed 🎉

    @princerajpoot20 (githubID: 44585452), please go to the dedicated AsyncAPI Microgrant Program 2026-08 page on Open Collective and submit an invoice for USD 400.00 (button 'ACTIONS', dropdown option 'Submit expense') with the full URL of this Microgrant Issue as the item description, the invoice title Microgrant openapi-schema-parser#326, and the tag microgrant.

    After submitting the invoice, please post the link to it in this Microgrant Issue as a separate comment to verify the invoice's authorship.

  21. princerajpoot20 commented on Sep 13, 2026

    @princerajpoot20
    MemberAuthor
  22. aeworxet commented on Sep 14, 2026

    @aeworxet

    princerajpoot20
    https://opencollective.com/asyncapi/projects/asyncapi-microgrant-program/expenses/346157

    ✅
    The invoice https://opencollective.com/asyncapi/projects/asyncapi-microgrant-program/expenses/346157 was submitted by @princerajpoot20 (githubID: 44585452), who was the AsyncAPI Microgrant Program 2026-08 Participant and completed the Microgrant Issue openapi-schema-parser#326.

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

Metadata

Metadata

Labels

micrograntParticipation in the Microgrant Program

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions