/v2/apis/{apiId}/models/{modelId}

PATCH

Updates a Model.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/v2/apis//models/' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

200 - Example 1

{
  "ContentType": "string",
  "Description": "string",
  "ModelId": "string",
  "Name": "string",
  "Schema": "string"
}

Request

Path Params

apiId

string

required

The API identifier.

modelId

string

required

The model ID.

Body Params application/json

contentType

string

optional

A string with a length between [1-256].

description

string

optional

A string with a length between [0-1024].

name

string

optional

A string with a length between [1-128].

schema

string

optional

A string with a length between [0-32768].

Examples

Responses

🟢200Success

application/json

Body

ContentType

string

optional

The content-type for the model, for example, "application/json".

Description

string

optional

The description of the model.

ModelId

string

optional

The model identifier.

Name

string

optional

The name of the model. Must be alphanumeric.

Schema

string

optional

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

🟠480NotFoundException

🟠481TooManyRequestsException

🟠482BadRequestException

🟠483ConflictException

Modified at 2023-08-15 05:49:07

/v2/apis/{apiId}/models/{modelId}

/v2/apis/{apiId}/routes/{routeId}