UpdateDeploymentCredentialRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/snyk/main/json-schema/snyk-update-deployment-credential-request-schema.json",
  "title": "UpdateDeploymentCredentialRequest",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/snyk-deploymentcredentials-api-openapi.yml#/components/schemas/UpdateDeploymentCredentialRequest",
  "additionalProperties": false,
  "properties": {
    "data": {
      "$ref": "#/$defs/DeploymentCredentialResource"
    }
  },
  "required": [
    "data"
  ],
  "type": "object",
  "$defs": {
    "ConnectionRelationship": {
      "additionalProperties": false,
      "properties": {
        "data": {
          "properties": {
            "id": {
              "description": "Associated item id",
              "type": "string"
            },
            "type": {
              "description": "Associated item type",
              "type": "string"
            }
          },
          "required": [
            "id",
            "type"
          ],
          "type": "object"
        }
      },
      "required": [
        "data"
      ],
      "type": "object"
    },
    "ConnectionRelationships": {
      "additionalProperties": false,
      "properties": {
        "broker_connections": {
          "items": {
            "$ref": "#/$defs/ConnectionRelationship"
          },
          "type": "array"
        },
        "jsonapi": {
          "$ref": "#/$defs/JsonApi"
        },
        "links": {
          "$ref": "#/$defs/PaginatedLinks"
        }
      },
      "required": [
        "broker_connections"
      ],
      "type": "object"
    },
    "DeploymentCredentialAttributes": {
      "additionalProperties": false,
      "properties": {
        "comment": {
          "description": "Optional comment information",
          "type": "string"
        },
        "deployment_id": {
          "description": "Associated Deployment ID",
          "format": "uuid",
          "readOnly": true,
          "type": "string"
        },
        "environment_variable_name": {
          "type": "string"
        },
        "type": {
          "description": "Associated connection type",
          "type": "string"
        }
      },
      "required": [
        "deployment_id",
        "environment_variable_name",
        "type"
      ],
      "type": "object"
    },
    "DeploymentCredentialResource": {
      "additionalProperties": false,
      "properties": {
        "attributes": {
          "$ref": "#/$defs/DeploymentCredentialAttributes"
        },
        "id": {
          "format": "uuid",
          "readOnly": true,
          "type": "string"
        },
        "relationships": {
          "$ref": "#/$defs/ConnectionRelationships"
        },
        "type": {
          "enum": [
            "deployment_credential"
          ],
          "type": "string"
        }
      },
      "required": [
        "attributes",
        "id",
        "type"
      ],
      "type": "object"
    },
    "JsonApi": {
      "additionalProperties": false,
      "properties": {
        "version": {
          "description": "Version of the JSON API specification this server supports.",
          "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
          "type": "string"
        }
      },
      "required": [
        "version"
      ],
      "type": "object"
    },
    "LinkProperty": {
      "oneOf": [
        {
          "description": "A string containing the link’s URL.",
          "type": "string"
        },
        {
          "additionalProperties": false,
          "properties": {
            "href": {
              "description": "A string containing the link’s URL.",
              "type": "string"
            },
            "meta": {
              "additionalProperties": true,
              "description": "Free-form object that may contain non-standard information.",
              "type": "object"
            }
          },
          "required": [
            "href"
          ],
          "type": "object"
        }
      ]
    },
    "PaginatedLinks": {
      "additionalProperties": false,
      "properties": {
        "first": {
          "$ref": "#/$defs/LinkProperty"
        },
        "last": {
          "$ref": "#/$defs/LinkProperty"
        },
        "next": {
          "$ref": "#/$defs/LinkProperty"
        },
        "prev": {
          "$ref": "#/$defs/LinkProperty"
        },
        "self": {
          "$ref": "#/$defs/LinkProperty"
        }
      },
      "type": "object"
    }
  }
}