feat: allow linting OpenAPI path templates #3532
Conversation
char0n
added
enhancement
| @@ -83,4 +84,5 @@ export default { | |||
| tag: tagMeta, | |||
| xml: xmlMeta, | |||
| schema: schemaMeta, | |||
| 'path-template': pathTemplateMeta, | |||
There was a problem hiding this comment.
Here we're attaching our meta (containing linting rules) to the path-template meta class.
| linterFunction: 'apilintOpenAPIPathTemplateValid', | ||
| marker: 'value', | ||
| targetSpecs: OpenAPI, | ||
| conditions: [ |
There was a problem hiding this comment.
We want to validate matching of Paramater Objects only when the path template is well formed and contains at least one template expression. That is achieved by params: [true].
| message: "'path' must begin with '/' and be relative to an individual endpoint", | ||
| severity: DiagnosticSeverity.Error, | ||
| linterFunction: 'apilintOpenAPIPathTemplateWellFormed', | ||
| linterParams: [false], |
There was a problem hiding this comment.
Here we don't care if path template contains at least one template expression, as long as the entire path template is well formed.
| }, | ||
| { | ||
| functionName: 'apilintOpenAPIPathTemplateValid', | ||
| function: (element: Element) => { |
There was a problem hiding this comment.
This is where you need to implement the logic of matching template expressions against the Parameter Objects.
| @@ -26,6 +26,8 @@ const PathsVisitor = stampit(PatternedFieldsVisitor, FallbackVisitor, { | |||
| this.element | |||
| .filter(isPathItemElement) | |||
| .forEach((pathItemElement: PathItemElement, key: StringElement) => { | |||
| key.classes.push('openapi-path-template'); | |||
There was a problem hiding this comment.
Attaching metadata classes.
| @@ -26,6 +26,8 @@ const PathsVisitor = stampit(PatternedFieldsVisitor, FallbackVisitor, { | |||
| this.element | |||
| .filter(isPathItemElement) | |||
| .forEach((pathItemElement: PathItemElement, key: StringElement) => { | |||
| key.classes.push('openapi-path-template'); | |||
There was a problem hiding this comment.
Attaching metadata classes.
Refs #3517