#1409·apidoc

getting warning when url has param with apiParam from apiUse

Author: gemalCreated Jun 27, 2023Updated Oct 18, 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):