API tools faq
paste
Guest User

Untitled

a guest
May 18th, 2016
98
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 6.70 KB | None | 0 0
raw download clone embed print report
  1. # Possible API endpoints
  2.  
  3. ## Home
  4.  
  5. | Method | Endpoint | Function | Authorization |
  6. |--------|---------------------------------|-----------------|---------------|
  7. | GET | / | Home page | Visitor |
  8. | GET | /[ not "admin" ] | Admin dashboard | Admin |
  9.  
  10. ## Users
  11.  
  12. | Method | Endpoint | Function | Authorization |
  13. |--------|-----------------|----------------------------------|--------------------------------|
  14. | GET | /users/ | return all users | Admin |
  15. | POST | /users/ | Create new user | Admin |
  16. | POST | /users/register | create new user | Visitor |
  17. | POST | /users/login | login | User |
  18. | GET | /users/logout | logout | Visitor |
  19. | GET | /users/:userID | Get info for user with id userID | Admin or User with matching ID |
  20. | PUT | /users/:userID | update user with id userID | Admin or User with matching ID |
  21. | DELETE | /users/:userID | deactivate user with id userID | Admin |
  22.  
  23. ## Adventures
  24.  
  25. | Method | Endpoint | Function | Authorization |
  26. |--------|------------------------------------|------------------------------------------------------|--------------------------------|
  27. | GET | /adventures | redirect to search? | Visitor |
  28. | POST | /adventures | add a new adventure | User |
  29. | GET | /adventures/:advID | return adventure matching with id :advID | Visitor |
  30. | PUT | /adventures/:advID | edit adventure | Admin or User with matching ID |
  31. | DELETE | /adventures/:advID | delete adventure | Admin or User with matching ID |
  32. | GET | /adventures/:advID/comments | return all comments for adventure :advID | Visitor |
  33. | POST | /adventures/:advID/comments | add new comment to adventure :advID | User |
  34. | GET | /adventures/:advID/comments/:comID | return comment :comID for adventure :advID | Visitor |
  35. | PUT | /adventures/:advID/comments/:comID | edit comment :comID for adventure :advID | Admin or User with matching ID |
  36. | DELETE | /adventures/:advID/comments/:comID | delete comment :comID for adventure :advID | Admin or User with matching ID |
  37.  
  38. ## Search
  39.  
  40. - Mostly from https://www.reddit.com/r/AdventureLookup/comments/4jqe6d/what_data_do_we_actually_care_about/
  41.  
  42. - This is just a sample of possible search params. Someone should go through this once the actual search fields become more apparent.
  43.  
  44. | Method | Endpoint | Query | Function | Authorization |
  45. |--------|----------|----------------------|-----------------------------------------------------------------|---------------|
  46. | GET | /search? | query=querystring | simple search | Visitor |
  47. | GET | /search? | q=querystring | simple search | Visitor |
  48. | GET | /search? | page=pagenum | pagination | Visitor |
  49. | GET | /search? | limit=100&offset=200 | alternate pagination candidate | Visitor |
  50. | GET | /search? | title=advtitle | return advs where title matches this | Visitor |
  51. | GET | /search? | pub=advpublisher | return advs where publisher matches this | Visitor |
  52. | GET | /search? | ed=edition | return advs where edition matches this | Visitor |
  53. | GET | /search? | set=setting | return advs where setting matches this | Visitor |
  54. | GET | /search? | pub=date | return advs where publish date matchis this | Visitor |
  55. | GET | /search? | minlvl=1 | return advs where min level matches this | Visitor |
  56. | GET | /search? | maxlvl=20 | return advs where max level matches this | Visitor |
  57. | GET | /search? | level=5 | return advs where this is between minlvl and maxlvl | Visitor |
  58. | GET | /search? | sessions=2 | return advs where expected sessions matches this | Visitor |
  59. | GET | /search? | hours=4 | return advs where expected num of hours matches this | Visitor |
  60. | GET | /search? | maps=0 or 1 | return advs that have/don't have maps | Visitor |
  61. | GET | /search? | art=0 or 1 | return advs that have/don't have art | Visitor |
  62. | GET | /search? | artist=artistname | return advs where artist matches this | Visitor |
  63. | GET | /search? | rating=rating | return advs where rating matches this | Visitor |
  64. | GET | /search? | alnmt=good | return advs where alignment matches this | Visitor |
  65. | GET | /search? | setting=eberron | return advs where setting matches this | Visitor |
  66. | GET | /search? | locale=underdark | return advs where locale matches this | Visitor |
  67. | GET | /search? | rr=0 or 1 | return advs that are railroad or sandbox | Visitor |
  68. | GET | /search? | magic=magiclevel | return advs that are based in a world with high/low/other magic | Visitor |
  69. | GET | /search? | series=0 or 1 | return advs that are part of a series (or not) | Visitor |
  70. | GET | /search? | theme=sometheme | return advs where theme matches this | Visitor |
  71. | GET | /search? | haspcs=0 or 1 | return advs that provide player characters (or don't) | Visitor |
Add Comment
Please, Sign In to add comment
Public Pastes
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!