Update metadata of a plugin
PATCH/v1/plugins/:identifier
This route allows you to update the metadata of an existing plugin, such as its title, description, and parameter definitions.
Request
Parameters (JSON)
{
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^(?!\\.{1,2}$)[A-Za-z0-9@_.+:\\\\/=-]+$"
},
"in": "path",
"name": "identifier",
"required": true,
"description": "The identifier of the plugin to update."
}
]
}Request body schema (JSON)
{
"title": "Body",
"body": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"params": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"string",
"number",
"boolean",
"array",
"object",
"blueprint"
]
},
"isRequired": {
"type": "boolean"
},
"label": {
"type": "string"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"type",
"isRequired"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
}
},
"title": "updatePluginMetadataBodyInput"
}
}
}
}
}Responses
- 200
- 400
- 401
- 403
- 404
- 500
Default Response
Default Response
Default Response
Default Response
Default Response
Default Response
Responses (JSON)
{
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"identifier": {
"type": "string"
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"creatorId": {
"type": "string"
},
"lastUpdatedBy": {
"type": "string"
},
"size": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"params": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"isRequired": {
"type": "boolean"
},
"label": {
"type": "string"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"type",
"isRequired"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"source": {
"type": "string",
"enum": [
"user",
"port_ai",
"plugins_repo"
]
}
},
"required": [
"identifier",
"title",
"createdAt",
"updatedAt",
"creatorId",
"lastUpdatedBy",
"size",
"params",
"source"
],
"additionalProperties": false
}
},
"required": [
"ok",
"data"
],
"additionalProperties": false,
"title": "updatePluginMetadataResponse"
}
}
}
},
"400": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "serverError"
}
}
}
},
"401": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "serverError"
}
}
}
},
"403": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "serverError"
}
}
}
},
"404": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "serverError"
}
}
}
},
"500": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "serverError"
}
}
}
}
}
}