feat(apidom-ls): path template match parameter object lint

[kowalczyk-krzysztof]

Refs #3517

[char0n]

Left one bigger comment with the draft of possible semantic implementation without doing ApiDOM -> POJO conversions.

[kowalczyk-krzysztof]

@char0n I changed my implementation to be more semantic. I also modified the fixture to include a reference object and it seems that the linter function works on dereferenced specification so we don't need to handle that.

[char0n]

We're getting there! Please have a look at my CR comments. I'll duble-check the Reference Object handling when we have current CR comments handled.

[kowalczyk-krzysztof]

Thanks for the comments. I misunderstood the structure of Path Item Object and made some wrong assumptions 🤦🏻 But now I see what I've missed.
I'll also add fixtures and tests for OAS2.0 and OAS3.1 and modify the OAS3.0 one to take care of the missing cases.

We cannot use semantic predicates here.

Yeah I see, Intellisense was showing me a lot of different import options and I got confused and I choose one at random, I wasn't aware that those predicate functions differ. I also didn't know about the polymorphic check option.

[kowalczyk-krzysztof]

I modified my implementation according to above comments and I added fixtures for different OAS versions.
I'm not sure how to get rid of those @ts-ignore though since I can't really make assertions as there are no "generic" (as in, valid for any OAS version) types.

[char0n]

Some final nitpicks and possible enhancements.

[char0n]

I'm not sure how to get rid of those @ts-ignore though since I can't really make assertions as there are no "generic" (as in, valid for any OAS version) types.

We can use lowest common denominator which is ObjectElement. It should resolve issues with @ts-ignore

[kowalczyk-krzysztof]

Pushed the suggested changes. Thanks for the get suggestion, I completely forgot it exists. However, this suggestion:

parameterElements.forEach((parameter: ObjectElement) => {
  if (allowedLocation.includes(toValue(parameter.get('in')))) {
    pathTemplateResolveParams[toValue(parameter.get('name')) as string] = 'placeholder';
  }
});

doesn't work unfortunately, I still need to cast parameter (can't assign a type here) and changing the line below to be ObjectElement[]

const parameterElements: Element[] = [];

requires type casting in other places so I think this:

 parameterElements.forEach((parameter) => {
          if (allowedLocation.includes(toValue((parameter as ObjectElement).get('in')))) {
            pathTemplateResolveParams[toValue((parameter as ObjectElement).get('name'))] =
              'placeholder';
          }
        });

is the cleanest looking solution.

[char0n]

All right, we're looking good! Nice job!

WARNING: please don't merge, I'll need to double check the Reference Object handling and verify that we're working on dereferenced structure. After that I'll do the "sqash and merge".

Thanks for your patience ;]

[kowalczyk-krzysztof]

All right, we're looking good! Nice job!

WARNING: please don't merge, I'll need to double check the Reference Object handling and verify that we're working on dereferenced structure. After that I'll do the "sqash and merge".

Thanks for your patience ;]

Thanks for all the comments and suggestions 😄
I learned a lot about ApiDOM in this PR and hopefully my future PRs will require less help.