feat(apidom-ls): lint parameter defined in path template

[kowalczyk-krzysztof]

Refs #3546

[char0n]

All right, so our first order of business if to determine if the Parameter Object we're looking at is somehow related to Path Item Object that is attached inside the Paths Object. Let's focus on that first, and after we have this established we'll focus on looking at Operation Object parameters.

Path Item Object parameters

We're specifically talking about PathItem.parameters.

1. Determining Path Item relationship

We first need to determine if Parameter Object is part of PathItem.parameters. That is achieved by looking at Parameter Object parent and checking if the parent is ArrayElement with meta class of path-item-parameters.

Predicate will look like this:

const isInPathItemElement = isArrayElement(paramerElement.parent) && includesClasses(['path-item-parameters'], parameterElement.parent)
const pathItemElement = parameterElement.parent.parent.parent

Tip

We can avoid step 1. and all the following steps by immediately looking into Parameter.in values and checking if it's path.

2. Determining if Path Item is part of path templating

To determine if the found Path Item Object (the one we found in previous step) is part of path templating, we have to look at it's meta field called path. If Path Item Object has this meta field and the meta field is of StringElement type, that we've determined that Parameter Object is part of path templating.

Predicate will look like this:

const isPathItemPartOfPathTemplating = isStringElement(pathItemElement.meta.get('path');
const pathTemplate = toValue(pathItemElement.meta.get('path'));

3. Determining if Parameter Object is matched with path templating

This is a bit tricky. We'll have to use openapi-path-templating to parse the path template into the AST:

This path template /pets/{petId} will parse into following AST:

          ['path-template', '/pets/{petId}'],
          ['path', '/pets/{petId}'],
          ['slash', '/'],
          ['path-literal', 'pets'],
          ['slash', '/'],
          ['template-expression', '{petId}'],
          ['template-expression-param-name', 'petId'],

If the Parameter.in === path - we'll have to look for template-expression-param-name with value of Parameter.name inside the AST.

---

Only after we have the above implementation, it makes sense to focus on Operation.parameters...

[kowalczyk-krzysztof]

Thanks, for the comment @char0n. I made some changes and it seems to be working fine for Operation.parameters but I'm still stuck on when the parameter is defined like this:

openapi: 3.0.0
info:
  title: Foo
  version: 0.1.0
components:
  parameters:
    test_id:
      name: test_id
      in: path
      required: true
      schema:
        type: string
        format: uuid
        title: Test Id

What do I do in this case? Did I misunderstand something?
EDIT: Indeed, I misunderstood.

[char0n]

All right, so as discussed we'll handle the Operation.parameters in follow-up PR.

[kowalczyk-krzysztof]

@char0n Thanks for the suggestions. I implemented all of them and I also updated fixtures to include all the possible places where Parameters object can be defined.

[char0n]

Looking good here. Nice job!