Skip to content

Instantly share code, notes, and snippets.

@cadecairos

cadecairos/docs.md

Last active November 17, 2015 18:43
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save cadecairos/3eba81bb869fcf65326c to your computer and use it in GitHub Desktop.
Save cadecairos/3eba81bb869fcf65326c to your computer and use it in GitHub Desktop.
Download ZIP
WIP tag route documentation for api.webmaker.org
Raw
docs.md

GET /projects/featured-tags

Response:

// NOTE: tags ARE NOT stored or returned with a leading '#'
{
  "featured": [
    "tags", 
    "that", 
    "are", 
    "featured"
  ]
}

GET /projects/tagged/{tag}

route params

  • tag - return projects that are tagged with this tag
    • Do not prefix this parameter with a '#'

query params

  • count - The max amount of results to fetch. defaults to 10
  • page - The page of results to return. defaults to 1

response

{
  "status": "success",
  "projects": [
    {/* project 1 */},
    {/* project 2 */},
    /* ... */
    {/* project n */}
  ]
}
@alanmoo
Copy link

alanmoo commented Nov 17, 2015

How are the projects sorted?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment