Skip to content

Conversation

cka121
Copy link
Contributor

@cka121 cka121 commented Oct 10, 2025

This PR updates the README file of apidom-ns-openapi-3-1 package with documentation of
normalize-discriminator-mapping (POC), normalize-parameter-examples and normalize-header-examples.
#OSS-10

Screenshots (if appropriate):

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@cka121 cka121 marked this pull request as ready for review October 10, 2025 11:17
Copy link
Contributor

@glowcloud glowcloud left a comment

Choose a reason for hiding this comment

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

Let's maybe let others weigh in if some of these things sound better or not.

Copy link
Contributor

@glowcloud glowcloud left a comment

Choose a reason for hiding this comment

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

Looks good, just found some typos in the code.

@cka121 cka121 force-pushed the feat/OSS-10-add-missing-documentation-for-refactor-plugin branch from 9e28615 to 9cc6a6f Compare October 15, 2025 10:32
@cka121 cka121 force-pushed the feat/OSS-10-add-missing-documentation-for-refactor-plugin branch from 9cc6a6f to fbf3c76 Compare October 15, 2025 11:05
// {
// in: 'query',
// name: 'idempotent',
// schema: { type: 'number', examples: [ 2 ] },
Copy link
Contributor

Choose a reason for hiding this comment

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

nit:

Suggested change
// schema: { type: 'number', examples: [ 2 ] },
// schema: { type: 'number', examples: [2] },

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