New lint rule for detecting missing sample fragments

[savvyintegrations]

Reason/Context

In cases where both a path param and request body are marked as required, it would be great to have a lint rule that detected if one or both are missing fragments to form a complete sample.

Description

For more info see microcks/microcks#1256

Implementation ideas

No response

[lbroudoux]

I come back to this one, and I think, in fact, that the rule is already in place. We have this one today:

  microcks-examples-in-required-parameter:
    description: Required param must have examples
    message: "Required param must have examples"
    formats:
      - oas3
    severity: warn
    given: "$..parameters[?(@.required == true)]"
    then:
      field: examples
      function: truthy

that is actually fired by the example resources in that project:

49:11  warning  microcks-examples-in-required-parameter        Required param must have examples                                                                                                                                                                         paths./forecast/{region}.get.parameters[1]

I just wonder if the severity level shouldn't be upgraded to error instead of a simple warn? That's maybe what makes it go under the radar... What do you think?

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. Microcks is a Cloud Native Computing Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️