fix: path-parameters-defined rule false positive

[DmitryAnansky]

What/Why/How?

NOTE: SIMILAR FIX SHOULD BE APPLIED TO OLDER REDOCLY/CLI VERSION.

Added additional path-parameters-defined rule context during validation to track parameters for Path and Path that comes from callback.

Having this part of description as an example:

paths:
  /projects/{projectId}:
    post:
      operationId: createProject
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
      callbacks:
        onEvent:
          '{$request.body#/callbackUrl}':
            post:
              responses:
                '200':
                  description: OK
                '400':
                  description: Bad Request
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                callbackUrl:
                  type: string
      responses:
        '201':
          description: Created

    patch:
      operationId: updateProject
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK

Both /projects/{projectId} and {$request.body#/callbackUrl} validated by this rule as a separate PathItem.
The issue was that without context tracking we were handling patch operation as if it a part of {$request.body#/callbackUrl} path.

This time instead of having additional context and stack we are going to narrow down visitor access, handling separately Callback inside PathItem.

Reference

Closes: #2436

Testing

Screenshots (optional)

Check yourself

• Code changed? - Tested with Redoc/Realm/Reunite (internal)
• All new/updated code is covered by tests
• New package installed? - Tested in different environments (browser/node)
• Documentation update considered

Security

• The security impact of the change has been considered
• Code follows company security practices and guidelines

[changeset-bot]

🦋 Changeset detected

Latest commit: 4a08ebc

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

This PR includes changesets to release 3 packages

Name	Type
@redocly/openapi-core	Patch
@redocly/cli	Patch
@redocly/respect-core	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

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	78.69% (🎯 78%)	5911 / 7511
🔵	Statements	78.14% (🎯 78%)	6107 / 7815
🔵	Functions	81.89% (🎯 81%)	1221 / 1491
🔵	Branches	70.73% (🎯 70%)	4064 / 5745

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
packages/core/src/rules/common/path-params-defined.ts	96.49%	96%	92.59%	98.18%	103, 116

Generated in workflow #8097 for commit 4a08ebc by the Vitest Coverage Report Action

[AlbinaBlazhko17]

Have you tested this implementation with the different scenarios? e.g. adding unused parameters in the patch and in the callback operation?

[DmitryAnansky]

Have you tested this implementation with the different scenarios? e.g. adding unused parameters in the patch and in the callback operation?

Yes, its running the test from this branch #2438

[github-actions]

Command	Mean [s]	Min [s]	Max [s]	Relative
redocly lint resources/rebilly.yaml	1.386 ± 0.021	1.345	1.407	1.00
redocly-next lint resources/rebilly.yaml	1.389 ± 0.019	1.358	1.415	1.00 ± 0.02

[github-actions]

📦 A new experimental 🧪 version v0.0.0-snapshot.1765200839 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/[email protected]
# or
npm install @redocly/[email protected]
# or
npm install @redocly/[email protected]

⚠️ Note: This is a development build and may contain unstable features.