ibm-parameter-description rule should skip responses.links.{name}.parameters

IBM / openapi-validator

Configurable and extensible validator/linter for OpenAPI documents

Apache License 2.0

493 stars 88 forks source link

ibm-parameter-description rule should skip responses.links.{name}.parameters #651

Closed michelecurioni closed 7 months ago

michelecurioni commented 7 months ago

Hi, we're using openapi-validator 1.1.1

We wanted to introduce the "links" feature (https://swagger.io/docs/specification/links/) in our API specs, but the validator rule ibm-parameter-description fails. The "parameters" field under links does not have a "description" property in OpenAPI 3.0, but the above rule expects that all "parameters" in the API spec have a description.

Can you help us fix this?

Thanks, Michele

dpopp07 commented 7 months ago

Will you post an example of the link you're trying to add? Links should absolutely be supported - we use them in many of our APIs and I haven't seen this issue before.

michelecurioni commented 7 months ago

My mistake, somebody customized ibm-parameter-description rule at our end, and it fails. I tried with the original rule, and it's fine

dpopp07 commented 7 months ago

Ah - no worries! Glad it's working