Assets
Create asset schema
Create a schema asset.
The schema data can either be fetched from a URL, uploaded from a file, or sent inline as raw content.
Fetch example:
{
"asset_type": "SCHEMA",
"fetch": {
"url": "https://api.example.com/v1"
}
}
Upload example:
The file should first be uploaded to the Escape Platform using the upload endpoint.
The upload endpoint returns an id that should be used in the temporaryObjectKey field.
{
"asset_type": "SCHEMA",
"upload": {
"temporaryObjectKey": "00000000-0000-0000-0000-000000000000"
}
}
Inline content example:
Send the raw schema content directly (at most 2 MB) when the caller cannot PUT to the pre-signed upload URL. The content is stored and converted with the same BUILD_SCHEMA workflow. The response is the created schema asset; its id is the schemaId used to attach the schema to a profile.
{
"asset_type": "SCHEMA",
"content": "{ \"openapi\": \"3.0.0\", ... }",
"contentType": "application/json",
"filename": "schema.json"
}
post/assets/schema
Request
- Base URLhttps://public.escape.tech/v3
- AuthAPI key in header X-ESCAPE-API-KEY
Request body
Example request
{
"name": "My Schema",
"fetch": {
"url": "https://api.example.com/v1",
"proxyId": "00000000-0000-0000-0000-000000000000",
"defaultProxyType": "PRIVATE"
},
"authentication": {
"users": [
{
"name": "public"
}
]
},
"authenticationStr": "{\"users\":[{\"name\":\"public\"}]}"
}Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.