Upload and scan an API description file

An API description file must adhere to the OpenAPI specification and be written in YAML or JSON format. The file name should be provided as the value for the file_name parameter. The contents of the file must be base64 encoded and supplied as the value for the file_data parameter.

POST /waap/v1/domains/{domain_id}/api-discovery/upload

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
waap_task_id = client.waap.domains.api_discovery.openapi.upload(
    domain_id=1,
    file_data="file_data",
    file_name="file_name",
)
print(waap_task_id.id)

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

domain_id · integer · required

The domain ID

Body

application/json

Request model for uploading an API spec file

file_name · string · required

The name of the file

file_data · string · required

Base64 representation of the description file. Supported formats are YAML and JSON, and it must adhere to OpenAPI versions 2, 3, or 3.1.

Response

200

application/json

Successful Response

Response model for the task result ID

id · string<uuid> · required

The task ID