Skip to content
This repository has been archived by the owner on Apr 23, 2019. It is now read-only.

Change nav and request structure a bit #2

Open
jayrbolton opened this issue Oct 20, 2016 · 2 comments
Open

Change nav and request structure a bit #2

jayrbolton opened this issue Oct 20, 2016 · 2 comments

Comments

@jayrbolton
Copy link
Contributor

jayrbolton commented Oct 20, 2016

Our API will soon be very large. I propose we restructure nav and options ajax

  • at top level, list each resource
  • 2nd level: list available methods as headers, and below each header list the available sub-paths for each method (including the root)
  • 2nd level is collapsed by default. They both get fully expanded when you click a resource. When you click a resource, the ajax request for that resource is made to load all its methods. The first api page for that resource could be immediately shown (usually get /)

example:

  • nonprofits
    • get
    • /
    • /profile
    • /metrics
    • update
    • /
    • /verification
  • supporters
    • get
    • /
    • update
    • /
@jayrbolton
Copy link
Contributor Author

@yutakahoulette whaddya think?

@yutakahoulette-zz
Copy link
Contributor

👍

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants