Forum Discussion

MeltingMosaic's avatar
MeltingMosaic
Occasional Contributor
8 years ago

Editor showing error, but jumping to the line doesn't seem to make sense

Hi, in my API: https://app.swaggerhub.com/api/MeltingMosaic/BungieNetProxy/1.0.0   I'm seeing this error in the editor: ptr must be a JSON Pointer   Clicking jump to line doesn't actually go an...
  • RonRatovsky's avatar
    RonRatovsky
    8 years ago

    Hello there!

     

    Well, this is a bit embarrassing. You've hit an edge case.

     

    The error itself is confusing and it's definitely pointing to the wrong line.

    However, fear not!

     

    I've forked your API and solved the issue(s), you can find it at https://app.swaggerhub.com/api/webron/BungieNetProxy/1.0.0.

     

    The problem was with two references, at lines 481 and 505. The reference is missing a slash after the #.

    So

    - $ref: "#parameters/BungieNetApiKey"

     

    should be

    - $ref: "#/parameters/BungieNetApiKey"

     

    Fix those two, and you're golden!

     

    We're working on some major changes to the editor that will help avoid this issues... This update is very close.

     

    On a slightly different subject - Bungie.net? :)

     

    Thanks,

    Ron

RonRatovsky's avatar
RonRatovsky
Staff

In your case the issue is different - you mix YAML and JSON in your spec, which is technically valid, but it is not well indented and YAML is sensitive to that.

 

The content directly under the `definitions`section needs to be modified. Take a look at https://app.swaggerhub.com/api/webron/hierarchy/1.0.0. Note that one you make the modifications, it will reveal other issues you'd need to fix.

dunkc's avatar
dunkc
Occasional Contributor
8 years ago

Thanks for the quick response. I've been through the data definitions and indented them correctly but still have errors. When you say there's an error in the content directly under the 'definitions' section do you mean the first object i.e. the addressPhysical object? as I can't see what the problem with this is.

 

The reason for the mix of YAML and JSON is that the data architects like to provide their input (i.e. the data defintions in JSON) whereas I prefer to define the API in YAML. It's a matter of taste, I could go through the JSON and change it to YAML, but it's a long winded job.

  • RonRatovsky's avatar
    RonRatovsky
    Staff
    8 years ago

    The link I shared is a copy of your spec with the fixed indentation, so you can use that as a reference.

     

    As for JSON/YAML - it's very easy to convert between the two, there are multiple tools out there to do that. In the near future, we will also offer to convert JSON to YAML automatically when you import a JSON file, or even when you just paste a JSON snippet into an existing spec.

    • dunkc's avatar
      dunkc
      Occasional Contributor
      8 years ago

      Thanks, I've created a YAML version (you're right it wasn't too arduous) but now I get a schema errors "Not a valid Schema" and "A deterministic version of a JSON schema object".

       

      The problem seems to be resolving the hierarchyParty definition from the hierarchyTier. In the API docs it shows as 'undefined'. However, the identical definition is also used in hierarchyRole and resolves ok. So I'm a bit confused.

       

      There is a third error saying 'not a valid response definition' but I assume this is due to the schema problem.

       

      I also had a few more similar errors where an array had a maxitems of 1 defined, removing this attribute removed the errors.

       

      The new definition is at https://app.swaggerhub.com/api/dunkc/org-hierarchy/1.0.0. I'd appreciate it if you could shed any light on this please

       

       

      • dunkc's avatar
        dunkc
        Occasional Contributor
        8 years ago

        Finally got this error free....thanks for your help