Order of resolution of references - resolve remotes first?

Given this folder structure:

|   index.yaml
|   parameters.yaml
|   responses.yaml
|   
+---definitions
|   |   index.yaml
|   |   
|   +---error
|   |       error_model.yaml
|   |       extended_error_model.yaml
|               
\---paths
    |   index.yaml

Consider this yaml:

index.yaml

swagger: '2.0'

info:
  version: 1.0.0
  title: User API
  description: User specific API

schemes:
  - http
  - https

produces:
  - application/json
  - text/json

paths:
  $ref: ./paths/index.yaml

definitions:
  $ref: ./definitions/index.yaml

parameters:
  $ref: ./parameters.yaml

responses:
  $ref: ./responses.yaml

responses.yaml

# Common responses
200:
  description: OK
  schema:
    type: string

DefaultError:
  description: Error payload
  schema:
    $ref: '#/definitions/ExtendedErrorModel'

extended_error_model.yaml

allOf:
- $ref: '#/definitions/ErrorModel'
- type: object
  properties:
    detail:
      type: string
    meta:
      type: string

error_model.yaml

type: object
required:
  - status
  - code
  - title
properties:
  code:
    type: integer
  title:
    type: string
  status:
    type: integer
    minimum: 100
    maximum: 600

SwaggerParser.validate('index.yaml') fails because '#/definitions/ExtendedErrorModel' doesn’t exist inside responses.yaml. However, if I use json-refs and js-yaml to load and parse the YAML, the resolution works.

I believe this is because json-refs first resolves all remote refs, then proceeds with local ones.

I’m not sure if the spec (OAI or json ref) dictates one way or the other. So I’m not sure if this is an issue or not.

Could you please shed some light on this?

[whitlockjc]

No problem. The good news is this feature was a pain to implement anyways so removing it makes my life easier. 👍

[JamesMessinger]

Closing this issue, since Swagger Parser is working as intended.