Error resolving refs on twitter API

[chrisdudley]

I tried resolving references on the twitter API YAML file:
https://github.com/swagger-api/swagger-editor/blob/master/app/spec-files/twitter.yaml

$json-refs resolve twitter.yaml --force

  error: duplicated mapping key at line 236, column 23:
              type: string
                          ^

The twitter API seems to contain some circular references in the model definitions - could that be causing the error?

[whitlockjc]

After further review, it seems the example twitter.yaml you're attempting to use is invalid as it's got duplicate type keys. I realize this is valid YAML but a number of YAML libraries out there will alert you when this situation arises and it seems that the one we use does this:

1. https://github.com/swagger-api/swagger-editor/blob/master/app/spec-files/twitter.yaml#L232
2. https://github.com/swagger-api/swagger-editor/blob/master/app/spec-files/twitter.yaml#L236

I personally like this as it's usually a mistake, like this one, that you have duplicate keys. There isn't much I can do for you and there should be an issue or PR brought up for https://github.com/swagger-api/swagger-editor

[chrisdudley]

Thanks. I'll raise one on swagger-editor.

[whitlockjc]

No sweat! If I can help with anything else, don't hesitate to reach out. :)

[chrisdudley]

Fixed that one but then hit the next error:
chris@chriss-mbp-2:~/temp|⇒ json-refs resolve twitter.yaml

  error: duplicated mapping key at line 338, column 3:
      /statuses/oembed:
      ^

What's going on there?

[whitlockjc]

I've found that js-yaml will report that the problematic line is X but it's really the construct prior to line X. The previous construct is the /statuses/retweets/{id} path and it's defined in two places, as js-yaml says:

• https://github.com/swagger-api/swagger-editor/blob/master/app/spec-files/twitter.yaml#L179
• https://github.com/swagger-api/swagger-editor/blob/master/app/spec-files/twitter.yaml#L315

So this is the same issue originally reported but it seems this example has more than one place where there are duplicate keys.

[chrisdudley]

Good spot, but even after resolving that and removing the duplicate operation it fails due to the circular references in the model definitions.
Is there any way that json-refs could handle them more gracefully, and either ignore, or only recurse down x levels or something?

[whitlockjc]

swagger-editor uses an old version of json-refs. As soon as they update, this should be fixed.

[chrisdudley]

I wasn't using it in swagger editor - but standalone npm install on my local machine.
(v2.1.5)

[whitlockjc]

What's the problem you're seeing? The way we handle this is we leave the circular reference in place and let the tooling handle it. We have an open issue to make this configurable but he safest thing is to just not touch circular refences. What do you want to happen?

[chrisdudley]

Leaving them in place would be fine.
Currently I get no output at all, just an error:

chris@Chriss-MBP-2:~/temp|⇒ json-refs resolve twitter.yaml

error: Converting circular structure to JSON

[chrisdudley]

twitter.yaml.txt
(I renamed it to be .txt to allow upload)

[whitlockjc]

We already handle circular references by just leaving them as-is so this is surprising. Let me see if I can find what is up.

[chrisdudley]

Hiya just wondering if you'd worked out what was going on?

[whitlockjc]

I got side tracked with my day job. I'll look into it now.