JSON Data API Docs

[ErisDS]

With the API cleaned up and consistent, we should document, for all available endpoints:

• the options / arguments available and what they do
• the possible return values
• the possible errors or warnings

[ErisDS]

@sebgie I've unassigned this from you - I don't think it should be up to you to do all of it, but I would appreciate if you'd make a start and create a Wiki document with an example of how one of the POST methods should be documented (and post the link here).

Thanks :)

[sebgie]

I have added an initial version for the API documentation to the Wiki (https://github.com/TryGhost/Ghost/wiki/%5BWIP%5D-API-Documentation). It contains an outline for the Post API. I'll add more content for posts over the next days.

[ErisDS]

Awesome :) Hopefully everyone else will add to this as they go

[hswolff]

I think using the wiki for documentation while this is under development is great, however I do think that moving the documentation inline into the code would be best once things are finalized. This will allow you to keep in one location the code and the documentation for that code, rather than in two separate locations which would have to be updated independently. This is related to my issue #2622 I've just raised.

[ErisDS]

The documentation in the wiki is intended to be moved into the official developer docs once the documentation is complete. Documentation which is in the code is a separate thing... I'll reply to #2622 shortly.

[AnneTheAgile]

@ErisDS perhaps I may ask you another Github-Fu question. You said that "By the end of 0.5, we should have competed #2124", and I see 0.5 is not released yet. Is there a page with the planned date?

[ErisDS]

@AnneTheAgile Roadmap - pretty much everything you could possibly want to know is right here on GitHub 😉

[ErisDS]

Closing in favour of #5588 don't really need issues to remind us to write documentation 😁