Class MetadataApi

Hierarchy

  • MetadataApi
    • MetadataApi

Constructors

constructor

Properties

basePath axios configuration

Methods

addMetadataSchemaToCollection getMetadataSchema updateMetadataSchemaByName

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns MetadataApi

Properties

Protected basePath

basePath: string

Protected axios

axios: AxiosInstance

Protected configuration

configuration: undefined | Configuration

Methods

addMetadataSchemaToCollection

  • Add metadata schema to collection

    Parameters

    • requestParameters: MetadataApiAddMetadataSchemaToCollectionRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<SuccessResponse, any>>

    Summary

    Add metadata schema to collection

    Throws

    Memberof

    MetadataApi

getMetadataSchema

  • Get collection metadata schema

    Parameters

    • requestParameters: MetadataApiGetMetadataSchemaRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<MetadataSchemaProperty[], any>>

    Summary

    Get collection metadata schema

    Throws

    Memberof

    MetadataApi

updateMetadataSchemaByName

  • Update metadata schema by name

    Parameters

    • requestParameters: MetadataApiUpdateMetadataSchemaByNameRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<SuccessResponse, any>>

    Summary

    Update metadata schema by name

    Throws

    Memberof

    MetadataApi

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc