restify / restify/node-restify
maxParamLength Undocumented
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 10.7k
- Forks
- 975
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 5
Description
Bug Report
Restify Version
Documentation ( we're using an old version but the current doc. is still wrong )
Node.js Version
N/A
Expected behaviour
The documentation should explain the maxParamLength
Actual behaviour
The maxParamLength server option should be included in the documentation. It's also a little strange that the server throws a 404 not found when a parameter is too long. It may be better to throw a 400 indicating the issue.
This section details what restify actually did when you ran your code
Server throws a 404 if a route parameter exceeds 100 character ( default in code ).
Cause
That's the way it's written. Just need to update the documentation.
Are you willing and able to fix this?
Sure - where's the documentation? I can submit a code change in the coming weeks if a change is warranted.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No documentation file or test is named. Start by locating the server-option documentation for maxParamLength and verify its default and behavior when a route parameter is too long. Done means the option and its behavior are documented; determine separately whether the proposed 404-versus-400 change is in scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100