search

buildasaurs / XcodeServer-API-Docs

Unofficial documentation of the Xcode Server API (Xcode 7 edition)
MIT License
71 stars 7 forks source link

API Blueprint parsing issues? #5

Open cojoj opened 9 years ago

cojoj commented 9 years ago

From line 133 there's some sort of syntax parsing issue... After this:

# Bot [/bots/{id}]

+ Model (application/json)

syntax highlighting on github and also in Sublime Text 3 is broken... Looks like one object is not closed or some brackets are missing. It's worth taking a look since working without syntax highlight is PITA 😢

cojoj commented 9 years ago

There's some problem with parsing 

+ Model (application/json)

section. In line 419 same thing happens that after Model syntax is lost... But if you comment out model JSON everything's back to normal.

czechboy0 commented 9 years ago

Haha this is insane. It seems like the API blueprint parser is confused by the underscores in Bot's key names _id, _rev etc. Try removing the underscore and the highlighting fixes itself.

I'll report it to them.

czechboy0 commented 9 years ago

@cojoj I only see the highlighting broken in Sublime Text and on GitHub, but not at Apiary.io. They must be using a different parser.

czechboy0 commented 9 years ago

https://github.com/apiaryio/api-blueprint/issues/241

cojoj commented 9 years ago

Well, well, well... Hope they'll fix it soon 😉

Yeah, Apiary.io works correctly but I have one question. Why

## List all Bots [GET]

+ Response 200

        {
            "count": 2,
            "results": [
                [Bot][],
                [Bot][]
            ]
        }

Isn't displayed correctly on Apiary.io?

czechboy0 commented 9 years ago

Because it's not officially supported :laughing: I just did it in the meantime before we switch to MSON at some point.