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

getting warning when url has param with apiParam from apiUse #1409

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

getting warning when url has param with apiParam from apiUse #1409

gemal opened this issue Jun 27, 2023 · 1 comment

Comments

@gemal
Copy link
Contributor

gemal commented Jun 27, 2023

Describe the bug

we have the following code:

    /**
     * @apiDefine Localization
     * @apiParam {string{2}} country Country code
     * @apiParam {string{5}} language Language code
     */

    /**
     * @api {post} /:country/:language/bills/add Add billing information
     * @apiDescription Adds billing information
     * @apiUse Localization
     */

Steps to reproduce

getting:

warn: URL contains a parameter ':country' that is not documented as @apiParam in @api 'Add billing information'

Information

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

Hello,

Please take into account that there is nobody available to maintain this library. See #1436.

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

No branches or pull requests

2 participants