Property rules skipped for $ref'd properties

[jeepshop]

Describe the bug
Some of my casing rules don't apply to property names if the property is a $ref: This is occurring within Stoplight Studio but it seems to be a spectral issue.

To Reproduce

1. Given this OpenAPI/AsyncAPI document model '...'

{
  "title": "Batman",
  "type": "object",
  "properties": {
    "Id": {
      "type": "integer"
    },
    "aircraftTail": {
      "$ref": "./AircraftTail.json"
    },
    "aircraft": {
      "type": "string"
    },
    "LAC": {
      "type": "integer"
    }
  }
}

2. With this ruleset

    "model-properties-pascal-case": {
      "description": "Model properties MUST be written in PascalCase",
      "message": "{{path}} should be PascalCase",
      "severity": "warn",
      "given": "$.properties[*]~",
      "then":{
        "function":"pattern",
        "functionOptions": {
          "match": "^[A-Z][a-zA-Z0-9]*$"
        }
      }
    }

Expected behavior
Both aircraftTail and aircraft should be tagged with a warning for not being PascalCased, however only aircraft is tagged. Any property that is a $ref, the property name isn't rule checked.

Screenshots

Environment (remove any that are not applicable):

• Stoplight Studio 2.8.0-statble.7260
• Windows 10

Additional context
This problem is reproducible in individual models as well as within the main document rules.

[P0lip]

I suppose the rule itself is not skipped, but the error itself is attached to a different file and therefore it's not exposed in the Diagnostics pane in Studio.
It's less of an issue in the context of CLI since the error should still be logged, but in the case of Studio it's more apparent since we only show errors that are specific to a particular file.

[michaelcilibrasi]

@jeepshop jeepshop

Hi JeepShot, in the Expected behavior screenshots, which editor are you using that both marks the lines and pops up the rule ID?

[jeepshop]

Hi JeepShot, in the Expected behavior screenshots, which editor are you using that both marks the lines and pops up the rule ID?

Stoplight Studio. Specifically in the Code view.

[canvural]

I also hit an issue similar to this. But looks like now error reporting for $ref is working, but error is attached to to $ref itself instead of the property name like aircraftTail Which causes confusion and it is really hard to find where is the real error.

[mskonovalov]

hmm, I'm still not sure if it is a bug or not but...
to what @canvural mentioned: reporting works fine just the rule itself is not working as everyone expecting
E.g. here is the example:

{
  "$id": "/schemas/test",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Test schema",
  "info": {
    "name": "TestSchema",
    "title": "Test Schema",
    "version": "2-0-0",
    "format": "jsonschema"
  },
  "properties": {
    "aaa": {
      "title": "aaa",
      "description": "The type",
      "type": "string"
    },
    "bbb": {
      "$ref": "./ref.schema.json"
    }
  },
  "required": ["type", "ref"]
}

{
  "$id": "/schemas/ref",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Description",
  "title": "Ref",
  "info": {
    "name": "Ref",
    "title": "Title",
    "format": "jsonschema"
  },
  "properties": {
    "ccc": {
      "title": "Ccc",
      "description": "The version of the event",
      "exampleValues": ["1-0-1"],
      "type": "string",
      "metadata": {
        "personalData": false
      }
    }
  },
  "required": ["version"]
}

So if we try to figure out how the refs are getting expanded I guess it will be something like that (omitted all the data that is not needed)

{
  "properties": {
    "aaa": { "title": "aaa" },
    "bbb": {
      "title": "bbb",
      "properties": {
        "ccc": { "title": "ccc" }
      }
    }
  }
}

so when you try to apply JsonPath like in the Op's example $.properties[*].title
it will actually return the following

["aaa", "bbb"]

Why not "ccc"? Because this JsonPath will match only top level properties, not the nested inside "bbb". (you can check it in online JsonPath editor)

To fix this issue you need to use recursive operator .. So in that case you jsonPath will become $..properties[*].title and this will match ["aaa", "bbb", "ccc"]

Hope that helps to somebody who bump their head at this :)