Skip to main content

Get a library

GET 
/libraries/:libraryId

The operation allows you to retrieve details about a specific library. A library constitutes a collection of pre-written and reusable code components, functions, and modules that enhance software development efficiency.

Request​

Path Parameters

    libraryId stringrequired

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Responses​

Library detail

Schema

    id stringrequired


    The unique identifier of the library. Based on the user-defined library name.

    name stringrequired


    The user-friendly name of the library. It allows users to provide a clear and descriptive name that helps in identifying and distinguishing different libraries easily. The field accepts free text with alphanumeric and special characters.

    description string


    The detailed textual description of the library. Allows users to add additional context, notes, or any relevant information about the purpose, usage, or characteristics of the library.

    state LibraryState (string)required

    Possible values: [CREATING, READY, FAILED, DELETING]

    State of the library
    CREATING - Library is being created
    READY - Library is ready
    FAILED - Library creation failed
    DELETING - Library is being deleted

    buildSystem stringnullable


    The name of the build system used for compiling, testing, and packaging code within the library.

    error

    object

    nullable


    Error details, if any, encountered during the library creation process.

    code string
    message string

    scm

    object

    required


    An object containing Source Code Management (SCM) information, including provider, repository/project ID, HTTP clone URL, and SSH clone URL.

    provider stringnullable


    The name of the SCM provider associated with the library, facilitating version control and collaborative software development.

    providerType stringnullable


    CI Provider type (gihub, codenow, etx)

    id stringnullable


    The unique identifier of the library repository or project within the SCM system.

    sshAddress stringrequired


    The SSH address string required for performing a Git clone operation on the repository linked to the library.

    httpAddress stringrequired


    The HTTP address string required for performing a Git clone operation on the repository linked to the library.

    template

    object

    required


    Template specification for the library.

    id stringrequired

    Possible values: non-empty


    An internal identifier of the scaffold selected for library creation.
    It includes information about the selected language, build tool and framework, if specified.
    Available templates can be obtained through the:
    /templates/application_components endpoint for application component or
    /templates/libraries endpoint for library

    version stringrequired

    Possible values: non-empty


    The desired version of the selected template.

    Available templates can be obtained through the:
    /templates/application_components endpoint for application component or
    /templates/libraries endpoint for library

    properties

    object


    A map of properties ("key": "value") required for proper template configuration.

    Available templates can be obtained through the:
    /templates/application_components endpoint for application component or
    /templates/libraries endpoint for library

    property name* string

    settings

    object

    Basic settings for the component

    contextPath string
    maxQueueSize int32

    ciSettings

    object

    CI settings for the component

    provider stringnullable


    Associated CI provider
    codenow - uses CodeNow CI
    external - uses external CI

    globalPipelinesConfiguration booleannullable


    A boolean flag indicating whether pipeline settings are globally configured for the entire repository. If set to false, the pipeline settings are independently customized for individual branches.

Loading...