Skip to main content

List of library templates

GET 

/templates/libraries

The operation allows you to retrieve a collection of all available library templates, which can be used to configure the template property of the LibraryCreateRequest.

Request

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Responses

List of library templates

Schema

  • Array [

  • id stringrequired


    The unique identifier of the library template.

    version stringrequired


    The currently provided version of the library template, using semantic versioning.

    name stringrequired


    The user-friendly name or label for the library template.

    language stringrequired


    The programming language supported by a library created from the template.

    languageVersion stringrequired


    The version of the programming language supported by a library created from the template.

    description stringrequired


    The textual description of the library template, which may provide some additional information in a user-friendly form.

    buildSystem stringrequired


    The name of the build system utilized by a library created from the template.

    buildSystemVersion stringrequired


    The version of the build system utilized by a library created from the template.

    framework stringrequired


    The name of the framework integrated with a library created from the template.

    frameworkVersion stringrequired


    The version of the framework integrated with a library created from the template.

    custom booleanrequired


    A boolean flag indicating whether the template is user-customized. If set to false, the template is provided by CodeNOW.

    properties

    object[]

    required


    A list of objects representing customizable template properties.

  • Array [

  • name stringrequired


    The name of the property, also serving as the unique identifier or key.

    description stringrequired


    The textual description of the property, providing better understanding of the property's function or context in a user-friendly form.

    type stringrequired


    The required data type of the property's value.

    required booleanrequired


    A boolean flag indicating whether the property is mandatory. If set to false, the property may be omitted.

  • ]

  • ]

Loading...