Discuss how the API should be advertised

[gdude2002]

• Is it a public API?
• If so, how do we document it?
  • I'd suggest an index page that details how the API should be used.

[Ribesg]

Well, for any documentation, I suggest using Markdown, it's simpler.

It is a public API imo. For example, IRC bots will love to use it.

[gdude2002]

I'd have thought it was a public API as well. And, yep, I can do Markdown, it's really fairly simple to do with Python. I think it should definitely be an index page rather than on GitHub, though.

[Ribesg]

Yeah didn't mean it should be a Github wiki.

[gdude2002]

Here's how it looks right now.

[gdude2002]

What do we think of this?

[greatman]

Fine to me.

[robbie-wilson]

Is it possible to have /format/ not be case sensitive?

[gdude2002]

Is it possible to have /format/ not be case sensitive?

Huh? Case insensitive routing?

When would you need to use uppercase or mixed case instead of lowercase?

Yes, it's possible, technically speaking, but it's a pain in the ass.

[robbie-wilson]

If its a pain in the ass it doesn't matter, just a suggestion.

[gdude2002]

Well, I'm not saying I wouldn't do it regardless, I'm just trying to think of a use case for it :P

[Ribesg]

It's not hard to do ._.

[gdude2002]

Is it possible to have /format/ not be case sensitive?

9845409...55b12bf

[lol768]

Use the Accept headers instead of the URL to specify formats.

[gdude2002]

Dumb clients won't do that (and noobs won't know how to do that); but I could add it as an optional way of doing things.