node-restify icon indicating copy to clipboard operation
node-restify copied to clipboard

maxParamLength Undocumented

Open jkennedy1980 opened this issue 4 years ago • 1 comments

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.

jkennedy1980 avatar Aug 02 '19 17:08 jkennedy1980

@jkennedy1980 maxParamLength property is from find-my-way module. In addition to updating documentation, needs to add specific HTTP return (error) code for example 414 - URI Too Long rather than 404.

regards, Jayesh

JayeshThamke avatar Oct 09 '19 09:10 JayeshThamke