danielgtaylor / danielgtaylor/aglio
Working with huge list of URI parameters
- Dominant language
- CoffeeScript
- Stars
- 4.7k
- Forks
- 471
- PR merge metrics
- No merged PRs in 30d
Description
Hi, we have an API with collection endpoints accepting huge number of filter URI parameters (more than 50).
We would like to document everything, but the problem is that aglio generates an horrible template URI with all the URI parameters.
For example.
```
GET /products{?param1,param2,param3,param4,param5,param6,param7,param8,param9,param10,param11}.
```
IMO generating URI templates is only "visually friendly" with very simple APIs, this is not the case with real world APIs.
So my question is, do we have any solution to prevent Aglio to generate those URI parameters is the rendered URI template ?
For my case generating only `GET /products` would be sufficient because the documentation of all the parameters is rendered after.
Thanks
Contributor guide
No contributing guide indexed for this repository
Research direction
The issue does not name a file, test, or entry point. Start by locating Aglio's URI-template rendering path and checking how rendered collection endpoints are tested. Done means a configuration or behavior prevents the long parameter list from appearing in the rendered URI while retaining the parameter documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- coffeescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100