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

adding an optional tabular view for index page. #27

Open
adityashedge opened this issue May 20, 2015 · 0 comments
Open

adding an optional tabular view for index page. #27

adityashedge opened this issue May 20, 2015 · 0 comments

Comments

@adityashedge
Copy link

  1. simple navbar with 'api_name'
  2. all api calls for resource listed in table with api details in columns
    column1 contains http method and route url combination(eg: 'GET /api/orders') and column2 contains 'description'(spec example name)
  3. option to choose between tabular view or the current view
  4. change also requires route url and http method info in index.json which will in turn be saved in 'IndexExample' instance

sample index.json file looks like below

{
  "resources": [
    {
      "name": "Orders",
      "examples": [
        {
          "description": "Creating an order",
          "link": "orders/creating_an_order.json",
          "groups": "all",
          "route": "/orders",
          "method": "post"
        },
        {
          "description": "Deleting an order",
          "link": "orders/deleting_an_order.json",
          "groups": "all",
          "route": "/orders/:id",
          "method": "delete"
        }
      ]
    }
  ]
}
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

Successfully merging a pull request may close this issue.

1 participant