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

Error when URL contain json: URL contains a parameter that is not documented as @apiParam #1408

Open
gemal opened this issue Jun 27, 2023 · 1 comment
Labels

Comments

@gemal
Copy link
Contributor

gemal commented Jun 27, 2023

Describe the bug

We have a URL like this:
/:country/:language/bills/add/:restaurantId/:bookingId.json
and we have:
@apiParam {Number} bookingId Booking ID.

and we keep getting:
warn: URL contains a parameter ':bookingId.json' that is not documented as @apiParam in @api 'Add billing information'

Steps to reproduce

can we somehow indicate that .json is NOT part of the param?

Information

  • Version of apidoc:: 1.0.3
  • Operating system (e.g. GNU+Linux/MacOS/Windows): windows
  • Node version: 18.16
  • Browser (e.g. firefox, chrome):
@NicolasCARPi
Copy link
Collaborator

can we somehow indicate that .json is NOT part of the param?

Probably need to fix the parser for this edge case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants