[Spce-user] Howto export API swagger definition file

[Vincent Dubois]

Try using the command line, I looked for swagger using grep and found this
bin/ngcp-api-generate-doc:                ($doc_format eq 'swagger-yml' ? ('swagger' => 'yml') : ()),
bin/ngcp-api-generate-doc:                ($doc_format eq 'swagger-json' ? ('swagger' => 'json') : ()),

so there is a command to generate it:
Usage:
     ngcp-api-generate-doc [options]

Options:
    --help
        Print a brief help message and exits.

    --format=format
        Specify the apidoc format (json/swagger-json/swagger-yml).

    --file=filename
        Specify a file to write the apidoc output to.

    --log-level
        Verbosity of printed messages while processing (debug, info, warn,
        error).

Vincent Dubois | Analyste programmeur
B2B2C
514-908-5420

From: Christian Treudler via Spce-user <spce-user at lists.sipwise.com>
Sent: August 19, 2025 6:51 AM
To: spce-user at lists.sipwise.com
Subject: [Spce-user] Howto export API swagger definition file

CAUTION : External Mail. Do not click on links or open attachments you do not trust.
ATTENTION : Courriel externe. Ne cliquez pas sur des liens et n'ouvrez pas de pièces jointes auxquels vous ne faites pas confiance.

Hello,

Can someone please explain to me how I can export the swagger definition from the API?

The URL
https://IP:1443/api/v2/swagger.json
https://IP:1443/api/v2/swagger.yaml
doesn't work


thank you
Christian

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.sipwise.com/pipermail/spce-user_lists.sipwise.com/attachments/20250819/89750b04/attachment-0001.htm>