Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cyberwave.com/llms.txt

Use this file to discover all available pages before exploring further.

cyberwave.rest.CatalogApi

All URIs are relative to http://localhost
MethodHTTP requestDescription
src_app_api_catalog_seed_seed_catalogPOST /api/v1/catalog/seedSeed Catalog
src_app_api_catalog_seed_seed_optionsGET /api/v1/catalog/seed-optionsSeed Options

src_app_api_catalog_seed_seed_catalog

CatalogSeedResponseSchema src_app_api_catalog_seed_seed_catalog(catalog_seed_request_schema)
Seed Catalog

Example

  • Api Key Authentication (CustomTokenAuthentication):
import cyberwave.rest
from cyberwave.rest.models.catalog_seed_request_schema import CatalogSeedRequestSchema
from cyberwave.rest.models.catalog_seed_response_schema import CatalogSeedResponseSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.CatalogApi(api_client)
    catalog_seed_request_schema = cyberwave.rest.CatalogSeedRequestSchema() # CatalogSeedRequestSchema | 

    try:
        # Seed Catalog
        api_response = api_instance.src_app_api_catalog_seed_seed_catalog(catalog_seed_request_schema)
        print("The response of CatalogApi->src_app_api_catalog_seed_seed_catalog:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CatalogApi->src_app_api_catalog_seed_seed_catalog: %s\n" % e)

Parameters

NameTypeDescriptionNotes
catalog_seed_request_schemaCatalogSeedRequestSchema

Return type

CatalogSeedResponseSchema

Authorization

CustomTokenAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-

src_app_api_catalog_seed_seed_options

CatalogSeedOptionsResponseSchema src_app_api_catalog_seed_seed_options()
Seed Options

Example

  • Api Key Authentication (CustomTokenAuthentication):
import cyberwave.rest
from cyberwave.rest.models.catalog_seed_options_response_schema import CatalogSeedOptionsResponseSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.CatalogApi(api_client)

    try:
        # Seed Options
        api_response = api_instance.src_app_api_catalog_seed_seed_options()
        print("The response of CatalogApi->src_app_api_catalog_seed_seed_options:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CatalogApi->src_app_api_catalog_seed_seed_options: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

CatalogSeedOptionsResponseSchema

Authorization

CustomTokenAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-