ProjectRelationships

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/snyk/main/json-schema/snyk-project-relationships-schema.json",
  "title": "ProjectRelationships",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/snyk-projects-api-openapi.yml#/components/schemas/ProjectRelationships",
  "additionalProperties": false,
  "properties": {
    "importer": {
      "$ref": "#/$defs/Relationship"
    },
    "organization": {
      "$ref": "#/$defs/Relationship"
    },
    "owner": {
      "$ref": "#/$defs/Relationship"
    },
    "target": {
      "oneOf": [
        {
          "$ref": "#/$defs/Relationship"
        },
        {
          "$ref": "#/$defs/ProjectRelationshipsTarget"
        }
      ]
    }
  },
  "required": [
    "target",
    "organization"
  ],
  "type": "object",
  "$defs": {
    "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"
        }
      ]
    },
    "Meta": {
      "additionalProperties": true,
      "description": "Free-form object that may contain non-standard information.",
      "type": "object"
    },
    "ProjectRelationshipsTarget": {
      "additionalProperties": false,
      "properties": {
        "data": {
          "properties": {
            "attributes": {
              "additionalProperties": false,
              "properties": {
                "display_name": {
                  "description": "The human readable name that represents this target. These are generated based on the provided properties, and the source. In the future we may support updating this value.\n",
                  "type": "string"
                },
                "url": {
                  "description": "The URL for the resource. We do not use this as part of our representation of the identity of the target, as it can      be changed externally to Snyk We are reliant on individual integrations providing us with this value. Currently it is only provided by the CLI\n",
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "type": "object"
            },
            "id": {
              "description": "The Resource ID.",
              "format": "uuid",
              "type": "string"
            },
            "meta": {
              "properties": {
                "integration_data": {
                  "description": "A collection of properties regarding integration data",
                  "type": "object"
                }
              },
              "type": "object"
            },
            "type": {
              "description": "The Resource type.",
              "type": "string"
            }
          },
          "required": [
            "type",
            "id",
            "attributes"
          ],
          "type": "object"
        },
        "links": {
          "$ref": "#/$defs/RelatedLink"
        }
      },
      "required": [
        "data",
        "links"
      ],
      "type": "object"
    },
    "RelatedLink": {
      "additionalProperties": false,
      "properties": {
        "related": {
          "$ref": "#/$defs/LinkProperty"
        }
      },
      "type": "object"
    },
    "Relationship": {
      "properties": {
        "data": {
          "additionalProperties": false,
          "properties": {
            "id": {
              "format": "uuid",
              "type": "string"
            },
            "type": {
              "description": "Type of the related resource",
              "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$",
              "type": "string"
            }
          },
          "required": [
            "type",
            "id"
          ],
          "type": "object"
        },
        "links": {
          "$ref": "#/$defs/RelatedLink"
        },
        "meta": {
          "$ref": "#/$defs/Meta"
        }
      },
      "required": [
        "data",
        "links"
      ],
      "type": "object"
    }
  }
}