Skip to content

Latest commit

 

History

History
153 lines (104 loc) · 7.6 KB

README.md

File metadata and controls

153 lines (104 loc) · 7.6 KB
Raw

Metadata

(metadata)

Overview

REST APIs for managing Version Metadata entities

Available Operations

delete_version_metadata

Delete metadata for a particular apiID and versionID.

Example Usage

from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

s = Speakeasy(
    security=shared.Security(
        api_key="<YOUR_API_KEY_HERE>",
    ),
)


res = s.metadata.delete_version_metadata(request={
    "api_id": "<value>",
    "version_id": "<value>",
    "meta_key": "<value>",
    "meta_value": "<value>",
})

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request operations.DeleteVersionMetadataRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.DeleteVersionMetadataResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

get_version_metadata

Get all metadata for a particular apiID and versionID.

Example Usage

from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

s = Speakeasy(
    security=shared.Security(
        api_key="<YOUR_API_KEY_HERE>",
    ),
)


res = s.metadata.get_version_metadata(request={
    "api_id": "<value>",
    "version_id": "<value>",
})

if res.version_metadata is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request operations.GetVersionMetadataRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetVersionMetadataResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

insert_version_metadata

Insert metadata for a particular apiID and versionID.

Example Usage

from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

s = Speakeasy(
    security=shared.Security(
        api_key="<YOUR_API_KEY_HERE>",
    ),
)


res = s.metadata.insert_version_metadata(request={
    "api_id": "<value>",
    "version_id": "<value>",
    "version_metadata": {
        "meta_key": "<value>",
        "meta_value": "<value>",
    },
})

if res.version_metadata is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request operations.InsertVersionMetadataRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.InsertVersionMetadataResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /