Edit model

Available in Classic and VPC

Edit the content of a created model.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
PUT	/api/v1/products/{product-id}/apis/{api-id}/models/{model-id}

Request headers

For information about the headers common to all API Gateway APIs, see API Gateway request headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`product-id`	String	Required	Product ID that the API belongs to 1 - 10 See View product list
`api-id`	String	Required	ID of the API whose model content you want to edit 1 - 10 characters See View API
`model-id`	String	Required	Target model ID 1 - 10 characters See View model

Request syntax

The request syntax is as follows.

{
  "modelDescription" : "modelDescription",
  "modelSchema" : "modelSchema"
}

Request body

The following describes the request body.

Field	Type	Required	Description
`modelDescription`	String	Optional	Model description 0 - 300 characters
`modelSchema`	String	Required	Schema of the model Use JSON schema

Request example

The following is a sample request.

curl --location --request PUT 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/models/tua1hd0pi4' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "modelDescription" : "test model for July update",
  "modelSchema" : "{\n  \"type\": \"object\",\n  \"properties\": {\n    \"firstName\": {\n      \"type\": \"string\"\n    },\n    \"lastName\": {\n      \"type\": \"string\"\n    },\n    \"age\": {\n      \"description\": \"Age in years\",\n      \"type\": \"integer\",\n      \"minimum\": 3\n    }\n  },\n  \"required\": [\n    \"firstName\",\n    \"lastName\"\n  ]\n}"
}'

Response

The following describes the response format.

Response syntax

The response syntax is as follows.

{
  "modelId" : "modelId",
  "apiId" : "apiId",
  "modelName" : "modelName",
  "modelDescription" : "modelDescription",
  "modelSchema" : "modelSchema"
}

Response status codes

For information about the HTTP status codes common to all API Gateway APIs, see API Gateway response status codes.

Response example

The following is a sample response.

{
    "modelId": "tua1hd0pi4",
    "apiId": "cvcohvd2xj",
    "modelName": "testmodel",
    "modelDescription": "test model for July update",
    "modelSchema": "{\n  \"type\": \"object\",\n  \"properties\": {\n    \"firstName\": {\n      \"type\": \"string\"\n    },\n    \"lastName\": {\n      \"type\": \"string\"\n    },\n    \"age\": {\n      \"description\": \"Age in years\",\n      \"type\": \"integer\",\n      \"minimum\": 3\n    }\n  },\n  \"required\": [\n    \"firstName\",\n    \"lastName\"\n  ]\n}"
}