dingo / dingo/blueprint

Resource parameters

Open
#24 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
PHP
Stars
270
Forks
105
PR merge metrics
No merged PRs in 30d

Description

@jasonlewis Just a quick question for clarification.

Currently you can define resource parameters and they get added to the resource list of parameters, but they won't get added to parameter list defined on method be it route or query parameter. E.g.

```
# Order [/user/{user_id}/order]
foo bar baz

+ Parameters
+ client_id (integer, required) - Client's ID

## List all orders [GET /user/{user_id}/order{?limit,offset}]
foo bar baz

+ Parameters
+ limit (integer, optional) - foo
+ offset (integer, optional) - bar
```

But since **user_id** won't get added to parameters defined for the method it will be impossible to make test requests from Apiary console, because I can not add the required parameter to the request. Since I don't know any other tools, I am taking strictly about Apiary here.

If this isn't the case then please correct me, but just in case my thinking is correct I have a PR ready.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.