Skip to content

BeautifulTrouble/api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 

Repository files navigation

API documentation for the various Beautiful projects

Content from the Beautiful Rising project -- a collaboration between Beautiful Trouble, Action Aid Denmark, and authors around the globe -- is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.

If you would like to include Beautiful Rising content in your own project, app, or website, the full content of the project is available programatically via a standard HTTP application programming interface (API). Details are below. If you have questions, please open an issue on this repository or contact us through the Beautiful Trouble website.

Beautiful Rising v1

The Beautiful Rising API is available at https://api.beautifulrising.org/api/

The API is versioned, so request will look like https://api.beautifulrising.org/api/v1/

The API currently returns JSON. Several object properties will also contain Markdown and it is left to the client to decide how to, or how not to, render this.

Endpoints

Module endpoints

  • /stories - Returns all story objects

  • /methodologies - Returns all methodology objects

  • /principles - Returns all principle objects

  • /theories - Returns all theory objects

  • /tactics - Returns all tactic objects

  • /people - Returns all people objects

To request a single resource, use:

The avaialble module types are:

  • /methodology
  • /principle
  • /story
  • /tactic
  • /theory
  • /person

Utility endpoints

  • /all - Returns all objects
  • /modules - Returns all "module" objects
  • /texts - Returns all text objects, e.g., static pages, user interface text, etc. A single text object can be retrieved with /text/[text-slug]
  • /config - Returns a configuration object containing miscellaneous esoterica

About

API documentation for the various Beautiful projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published