Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation needed #6

Open
danieleguido opened this issue Jun 15, 2017 · 0 comments
Open

Better documentation needed #6

danieleguido opened this issue Jun 15, 2017 · 0 comments

Comments

@danieleguido
Copy link

danieleguido commented Jun 15, 2017

get all the themes available

GET /api/story/?filters={"tags__slug":"theme"}&orderby=priority

get single theme and chapter metadata:

GET /api/story/grief-and-loss/

Note that:

  • theme background color is in metadata.background.overlay
  • theme bouncding box is in metadata.background.bbox = [xmin, ymin, xmax, ymax]
  • the theme cover is the first item in covers list
  • chapters are listed in stories property (light version, metadata only)
  • chapters ordering is given in metadata.chapters which contains the list of the pk of its related stories (so that the slugs of the related chapters may change without much hassle..

get single chapter, contents YAML parsed

GET /api/story/the-german-invasion/?parser=yaml
@danieleguido danieleguido changed the title Documentation needed Better documentation needed Jun 15, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant