Empty strings in paths

[TheTeaCat]

Hey, thanks to #581 I've gotten my custom rule working.

Unfortunately I'm now facing an issue with the path property in the report containing empty strings.

I'm running:

vacuum spectral-report -r custom-rules.yaml my-openapi-spec.yaml spectral.json

And here's all the assets:

custom-rules.yaml

extends: [all]
documentationUrl: https://example.com/docs
rules:
  define-magic-header:
    description: Response is missing a magic header.
    severity: error
    recommended: true
    formats: [oas2, oas3]
    given: $.paths..responses..headers
    then:
      field: "MagicHeader"
      function: defined
    howToFix: Ensure that the response includes a magic header.

my-openapi-spec.yaml

swagger: 2.0
info:
  title: My OpenAPI Spec
  version: v0.0.0
paths:
  /pets:
    post:
      responses:
        200:
          description: This needs my magic header
          headers:
            NotAMagicHeader:
              description: This is not the magic header
components: {}

And then the resultant spectral.json:

[
    {
        "code": "define-magic-header",
        "path": [
            "paths",
            "",
            "responses",
            "",
            "headers"
        ],
        "message": "Response is missing a magic header.: `MagicHeader` must be defined",
        "severity": 0,
        "range": {
            "start": {
                "line": 13,
                "character": 13
            },
            "end": {
                "line": 13,
                "character": 13
            }
        },
        "source": "my-openapi-spec.yaml"
    }
]

[daveshanley]

looks like a glitch - so it looks like the spectral-report needs a tuneup.

[daveshanley]

Should be fixed in v0.14.3

[TheTeaCat]

Thanks Dave, just tried v0.14.3 and I now get a different output, but there's still empty strings:

[
    {
        "code": "define-magic-header",
        "path": [
            "paths",
            "..",
            "",
            "responses",
            "..",
            "",
            "headers"
        ],
        "message": "Response is missing a magic header.: `MagicHeader` must be defined",
        "severity": 0,
        "range": {
            "start": {
                "line": 12,
                "character": 13
            },
            "end": {
                "line": 12,
                "character": 13
            }
        },
        "source": "my-openapi-spec.yaml"
    }
]

[daveshanley]

This is very odd. It’s not what I saw at all.

I guess I need to dig deeper. It was a light weight fix that seems to be ineffective.

[TheTeaCat]

Hey @daveshanley, have you been able to dig deeper?

[daveshanley]

I have not sorry, I have been working on the doctor - which requires a lot of focus. Once the next version of the stack is released I will circle back on bugs for a while - they are stacking up a bit.