Vue OpenAPI Query Documentation
    Preparing search index...

    Function buildUrl

    • Build a full URL string from a baseURL, an OpenAPI path template, optional path parameters, and optional query parameters.

      Intended for use-cases where a URL string is needed directly — e.g. — without executing a fetch.

      NOTE: Only flat scalar query params (string | number | boolean) are supported.

      Parameters

      • baseURL: string | undefined

        The axios instance baseURL. Read at call time.

      • path: string

        OpenAPI path template (e.g. "/v3/document/asset/{id}/file")

      • OptionalpathParams: Record<string, string | number | undefined> | null

        Values to substitute into the path template

      • OptionalqueryParams: Record<string, unknown> | null

        Key/value pairs to append as query string (undefined/null values are omitted)

      Returns string

    Settings

    Member Visibility