{
  "type": "object",
  "example": {
    "errors": [
      {
        "detail": "Permission denied for this resource",
        "status": "403"
      }
    ],
    "jsonapi": {
      "version": "1.0"
    }
  },
  "required": [
    "jsonapi",
    "errors"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "example": {
          "detail": "Not Found",
          "status": "404"
        },
        "required": [
          "status",
          "detail"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "f16c31b5-6129-4571-add8-d589da9be524",
            "description": "A unique identifier for this particular occurrence of the problem."
          },
          "code": {
            "type": "string",
            "example": "entity-not-found",
            "description": "An application-specific error code, expressed as a string value."
          },
          "meta": {
            "type": "object",
            "example": {
              "key": "value"
            },
            "additionalProperties": true
          },
          "title": {
            "type": "string",
            "example": "Bad request",
            "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
          },
          "detail": {
            "type": "string",
            "example": "The request was missing these required fields: ...",
            "description": "A human-readable explanation specific to this occurrence of the problem."
          },
          "source": {
            "type": "object",
            "example": {
              "pointer": "/data/attributes"
            },
            "properties": {
              "pointer": {
                "type": "string",
                "example": "/data/attributes",
                "description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
              },
              "parameter": {
                "type": "string",
                "example": "param1",
                "description": "A string indicating which URI query parameter caused the error."
              }
            }
          },
          "status": {
            "type": "string",
            "example": "400",
            "pattern": "^[45]\\d\\d$",
            "description": "The HTTP status code applicable to this problem, expressed as a string value."
          }
        }
      },
      "example": [
        {
          "detail": "Permission denied for this resource",
          "status": "403"
        }
      ],
      "minItems": 1
    },
    "jsonapi": {
      "type": "object",
      "example": {
        "version": "1.0"
      },
      "required": [
        "version"
      ],
      "properties": {
        "version": {
          "type": "string",
          "example": "1.0",
          "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
          "description": "Version of the JSON API specification this server supports."
        }
      }
    }
  }
}

{
  "required": [
    "jsonapi",
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/Issue"
    },
    "links": {
      "$ref": "#/components/schemas/PaginatedLinks"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}

{
  "type": "object",
  "example": {
    "errors": [
      {
        "detail": "Permission denied for this resource",
        "status": "403"
      }
    ],
    "jsonapi": {
      "version": "1.0"
    }
  },
  "required": [
    "jsonapi",
    "errors"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "example": {
          "detail": "Not Found",
          "status": "404"
        },
        "required": [
          "status",
          "detail"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "f16c31b5-6129-4571-add8-d589da9be524",
            "description": "A unique identifier for this particular occurrence of the problem."
          },
          "code": {
            "type": "string",
            "example": "entity-not-found",
            "description": "An application-specific error code, expressed as a string value."
          },
          "meta": {
            "type": "object",
            "example": {
              "key": "value"
            },
            "additionalProperties": true
          },
          "title": {
            "type": "string",
            "example": "Bad request",
            "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
          },
          "detail": {
            "type": "string",
            "example": "The request was missing these required fields: ...",
            "description": "A human-readable explanation specific to this occurrence of the problem."
          },
          "source": {
            "type": "object",
            "example": {
              "pointer": "/data/attributes"
            },
            "properties": {
              "pointer": {
                "type": "string",
                "example": "/data/attributes",
                "description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
              },
              "parameter": {
                "type": "string",
                "example": "param1",
                "description": "A string indicating which URI query parameter caused the error."
              }
            }
          },
          "status": {
            "type": "string",
            "example": "400",
            "pattern": "^[45]\\d\\d$",
            "description": "The HTTP status code applicable to this problem, expressed as a string value."
          }
        }
      },
      "example": [
        {
          "detail": "Permission denied for this resource",
          "status": "403"
        }
      ],
      "minItems": 1
    },
    "jsonapi": {
      "type": "object",
      "example": {
        "version": "1.0"
      },
      "required": [
        "version"
      ],
      "properties": {
        "version": {
          "type": "string",
          "example": "1.0",
          "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
          "description": "Version of the JSON API specification this server supports."
        }
      }
    }
  }
}

{
  "type": "object",
  "example": {
    "errors": [
      {
        "detail": "Permission denied for this resource",
        "status": "403"
      }
    ],
    "jsonapi": {
      "version": "1.0"
    }
  },
  "required": [
    "jsonapi",
    "errors"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "example": {
          "detail": "Not Found",
          "status": "404"
        },
        "required": [
          "status",
          "detail"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "f16c31b5-6129-4571-add8-d589da9be524",
            "description": "A unique identifier for this particular occurrence of the problem."
          },
          "code": {
            "type": "string",
            "example": "entity-not-found",
            "description": "An application-specific error code, expressed as a string value."
          },
          "meta": {
            "type": "object",
            "example": {
              "key": "value"
            },
            "additionalProperties": true
          },
          "title": {
            "type": "string",
            "example": "Bad request",
            "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
          },
          "detail": {
            "type": "string",
            "example": "The request was missing these required fields: ...",
            "description": "A human-readable explanation specific to this occurrence of the problem."
          },
          "source": {
            "type": "object",
            "example": {
              "pointer": "/data/attributes"
            },
            "properties": {
              "pointer": {
                "type": "string",
                "example": "/data/attributes",
                "description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
              },
              "parameter": {
                "type": "string",
                "example": "param1",
                "description": "A string indicating which URI query parameter caused the error."
              }
            }
          },
          "status": {
            "type": "string",
            "example": "400",
            "pattern": "^[45]\\d\\d$",
            "description": "The HTTP status code applicable to this problem, expressed as a string value."
          }
        }
      },
      "example": [
        {
          "detail": "Permission denied for this resource",
          "status": "403"
        }
      ],
      "minItems": 1
    },
    "jsonapi": {
      "type": "object",
      "example": {
        "version": "1.0"
      },
      "required": [
        "version"
      ],
      "properties": {
        "version": {
          "type": "string",
          "example": "1.0",
          "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
          "description": "Version of the JSON API specification this server supports."
        }
      }
    }
  }
}

{
  "type": "object",
  "example": {
    "errors": [
      {
        "detail": "Permission denied for this resource",
        "status": "403"
      }
    ],
    "jsonapi": {
      "version": "1.0"
    }
  },
  "required": [
    "jsonapi",
    "errors"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "example": {
          "detail": "Not Found",
          "status": "404"
        },
        "required": [
          "status",
          "detail"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "f16c31b5-6129-4571-add8-d589da9be524",
            "description": "A unique identifier for this particular occurrence of the problem."
          },
          "code": {
            "type": "string",
            "example": "entity-not-found",
            "description": "An application-specific error code, expressed as a string value."
          },
          "meta": {
            "type": "object",
            "example": {
              "key": "value"
            },
            "additionalProperties": true
          },
          "title": {
            "type": "string",
            "example": "Bad request",
            "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
          },
          "detail": {
            "type": "string",
            "example": "The request was missing these required fields: ...",
            "description": "A human-readable explanation specific to this occurrence of the problem."
          },
          "source": {
            "type": "object",
            "example": {
              "pointer": "/data/attributes"
            },
            "properties": {
              "pointer": {
                "type": "string",
                "example": "/data/attributes",
                "description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
              },
              "parameter": {
                "type": "string",
                "example": "param1",
                "description": "A string indicating which URI query parameter caused the error."
              }
            }
          },
          "status": {
            "type": "string",
            "example": "400",
            "pattern": "^[45]\\d\\d$",
            "description": "The HTTP status code applicable to this problem, expressed as a string value."
          }
        }
      },
      "example": [
        {
          "detail": "Permission denied for this resource",
          "status": "403"
        }
      ],
      "minItems": 1
    },
    "jsonapi": {
      "type": "object",
      "example": {
        "version": "1.0"
      },
      "required": [
        "version"
      ],
      "properties": {
        "version": {
          "type": "string",
          "example": "1.0",
          "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
          "description": "Version of the JSON API specification this server supports."
        }
      }
    }
  }
}

{
  "type": "object",
  "example": {
    "errors": [
      {
        "detail": "Permission denied for this resource",
        "status": "403"
      }
    ],
    "jsonapi": {
      "version": "1.0"
    }
  },
  "required": [
    "jsonapi",
    "errors"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "example": {
          "detail": "Not Found",
          "status": "404"
        },
        "required": [
          "status",
          "detail"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "f16c31b5-6129-4571-add8-d589da9be524",
            "description": "A unique identifier for this particular occurrence of the problem."
          },
          "code": {
            "type": "string",
            "example": "entity-not-found",
            "description": "An application-specific error code, expressed as a string value."
          },
          "meta": {
            "type": "object",
            "example": {
              "key": "value"
            },
            "additionalProperties": true
          },
          "title": {
            "type": "string",
            "example": "Bad request",
            "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
          },
          "detail": {
            "type": "string",
            "example": "The request was missing these required fields: ...",
            "description": "A human-readable explanation specific to this occurrence of the problem."
          },
          "source": {
            "type": "object",
            "example": {
              "pointer": "/data/attributes"
            },
            "properties": {
              "pointer": {
                "type": "string",
                "example": "/data/attributes",
                "description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
              },
              "parameter": {
                "type": "string",
                "example": "param1",
                "description": "A string indicating which URI query parameter caused the error."
              }
            }
          },
          "status": {
            "type": "string",
            "example": "400",
            "pattern": "^[45]\\d\\d$",
            "description": "The HTTP status code applicable to this problem, expressed as a string value."
          }
        }
      },
      "example": [
        {
          "detail": "Permission denied for this resource",
          "status": "403"
        }
      ],
      "minItems": 1
    },
    "jsonapi": {
      "type": "object",
      "example": {
        "version": "1.0"
      },
      "required": [
        "version"
      ],
      "properties": {
        "version": {
          "type": "string",
          "example": "1.0",
          "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
          "description": "Version of the JSON API specification this server supports."
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "package": {
      "$ref": "#/components/schemas/PackageMeta"
    }
  }
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CommonIssueModel"
      }
    },
    "meta": {
      "$ref": "#/components/schemas/IssuesMeta"
    },
    "links": {
      "$ref": "#/components/schemas/PaginatedLinks"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CommonIssueModelVTwo"
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "errors": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/PaginatedLinks"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}

{
  "type": "object",
  "example": {
    "version": "1.0"
  },
  "required": [
    "version"
  ],
  "properties": {
    "version": {
      "type": "string",
      "example": "1.0",
      "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
      "description": "Version of the JSON API specification this server supports."
    }
  }
}

{
  "type": "object",
  "properties": {
    "total": {
      "type": "number"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

{
  "type": "object",
  "properties": {
    "low": {
      "type": "number"
    },
    "high": {
      "type": "number"
    },
    "medium": {
      "type": "number"
    },
    "critical": {
      "type": "number"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

{
  "oneOf": [
    {
      "type": "string",
      "example": "https://example.com/api/resource",
      "description": "A string containing the link’s URL."
    },
    {
      "type": "object",
      "example": {
        "href": "https://example.com/api/resource"
      },
      "required": [
        "href"
      ],
      "properties": {
        "href": {
          "type": "string",
          "example": "https://example.com/api/resource",
          "description": "A string containing the link’s URL."
        },
        "meta": {
          "$ref": "#/components/schemas/Meta"
        }
      }
    }
  ],
  "example": "https://example.com/api/resource"
}

{
  "type": "object",
  "properties": {
    "last": {
      "$ref": "#/components/schemas/LinkProperty"
    },
    "next": {
      "$ref": "#/components/schemas/LinkProperty"
    },
    "prev": {
      "$ref": "#/components/schemas/LinkProperty"
    },
    "self": {
      "$ref": "#/components/schemas/LinkProperty"
    },
    "first": {
      "$ref": "#/components/schemas/LinkProperty"
    },
    "related": {
      "$ref": "#/components/schemas/LinkProperty"
    }
  }
}

{
  "type": "object",
  "properties": {
    "is_patch_remediation_enabled": {
      "type": "boolean",
      "example": true,
      "description": "Include vulnerability patches in manual pull requests."
    }
  },
  "description": "Manually raise pull requests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Project's integration."
}

{
  "type": "object",
  "nullable": true,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "example": "f60ff965-6889-4db2-8c86-0285d62f35ab",
          "description": "The Snyk ID of the organization role."
        },
        "type": {
          "$ref": "#/components/schemas/Types"
        },
        "attributes": {
          "$ref": "#/components/schemas/OrgRoleAttributes"
        }
      }
    }
  }
}

{
  "type": "object",
  "example": {
    "key1": "value1",
    "key2": {
      "sub_key": "sub_value"
    },
    "key3": [
      "array_value1",
      "array_value2"
    ]
  },
  "description": "Free-form object that may contain non-standard information.",
  "additionalProperties": true
}

{
  "type": "object",
  "required": [
    "target_framework"
  ],
  "properties": {
    "target_framework": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "required": [
    "name",
    "updated_at",
    "value"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "links": {
      "$ref": "#/components/schemas/RiskFactorLinks"
    },
    "value": {
      "type": "boolean"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "included_in_score": {
      "type": "boolean",
      "default": false
    }
  }
}

{
  "type": "string",
  "example": "latest",
  "description": "The tag for an OCI artifact inside an OCI registry."
}

{
  "type": "string",
  "example": "https://registry-1.docker.io/account/bundle",
  "description": "The URL to an OCI registry."
}

{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "type": "array",
  "items": {
    "type": "string"
  }
}

{
  "type": "object",
  "required": [
    "type",
    "id",
    "attributes"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "59d6d97e-3106-4ebb-b608-352fad9c5b34",
      "description": "The Snyk ID of the organization."
    },
    "type": {
      "$ref": "#/components/schemas/Types"
    },
    "attributes": {
      "$ref": "#/components/schemas/OrgAttributes"
    }
  }
}

{
  "type": "object",
  "required": [
    "name",
    "slug",
    "is_personal"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "My Org",
      "description": "The display name of the organization."
    },
    "slug": {
      "type": "string",
      "example": "my-org",
      "description": "The canonical (unique and URL-friendly) name of the organization."
    },
    "group_id": {
      "type": "string",
      "format": "uuid",
      "example": "59d6d97e-3106-4ebb-b608-352fad9c5b34",
      "description": "The Snyk ID of the group to which the organization belongs."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-16T00:00:00Z",
      "description": "The time the organization was created."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-16T00:00:00Z",
      "description": "The time the organization was last modified."
    },
    "is_personal": {
      "type": "boolean",
      "example": true,
      "description": "Whether the organization is independent (that is, not part of a group)."
    },
    "access_requests_enabled": {
      "type": "boolean",
      "example": false,
      "description": "Whether the organization permits access requests from users who are not members of the organization."
    }
  }
}

{
  "type": "object",
  "required": [
    "type",
    "attributes"
  ],
  "properties": {
    "type": {
      "type": "string",
      "example": "iac_settings",
      "description": "Content type"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "custom_rules": {
          "type": "object",
          "properties": {
            "is_enabled": {
              "$ref": "#/components/schemas/IsEnabled"
            },
            "oci_registry_tag": {
              "$ref": "#/components/schemas/OciRegistryTag"
            },
            "oci_registry_url": {
              "$ref": "#/components/schemas/OciRegistryUrl"
            },
            "inherit_from_parent": {
              "$ref": "#/components/schemas/InheritFromParent"
            }
          },
          "description": "The Infrastructure as Code custom rules settings for an org.",
          "minProperties": 1
        }
      }
    }
  },
  "description": "The Infrastructure as Code settings for an org."
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "ea536a06-0566-40ca-b96b-155568aa2027",
      "description": "ID"
    },
    "type": {
      "type": "string",
      "example": "iac_settings",
      "description": "Content type"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "custom_rules": {
          "type": "object",
          "properties": {
            "parents": {
              "type": "object",
              "properties": {
                "group": {
                  "type": "object",
                  "properties": {
                    "updated": {
                      "$ref": "#/components/schemas/Updated"
                    },
                    "custom_rules": {
                      "type": "object",
                      "properties": {
                        "is_enabled": {
                          "$ref": "#/components/schemas/IsEnabled"
                        },
                        "oci_registry_tag": {
                          "$ref": "#/components/schemas/OciRegistryTag"
                        },
                        "oci_registry_url": {
                          "$ref": "#/components/schemas/OciRegistryUrl"
                        }
                      },
                      "description": "The Infrastructure as Code custom rules settings for a group."
                    }
                  },
                  "description": "The Infrastructure as Code settings at the group level."
                }
              },
              "description": "Contains all parents the org can inherit settings from."
            },
            "updated": {
              "$ref": "#/components/schemas/Updated"
            },
            "is_enabled": {
              "$ref": "#/components/schemas/IsEnabled"
            },
            "oci_registry_tag": {
              "$ref": "#/components/schemas/OciRegistryTag"
            },
            "oci_registry_url": {
              "$ref": "#/components/schemas/OciRegistryUrl"
            },
            "inherit_from_parent": {
              "$ref": "#/components/schemas/InheritFromParent"
            }
          },
          "description": "The Infrastructure as Code custom rules settings for an org."
        }
      }
    }
  },
  "description": "The Infrastructure as Code settings for an org."
}

{
  "type": "object",
  "required": [
    "type",
    "id",
    "attributes"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "type": {
      "enum": [
        "org_invitation"
      ],
      "type": "string"
    },
    "attributes": {
      "$ref": "#/components/schemas/OrgInvitationAttributes"
    },
    "relationships": {
      "type": "object",
      "properties": {
        "org": {
          "$ref": "#/components/schemas/Relationship"
        }
      }
    }
  }
}

{
  "type": "object",
  "required": [
    "email",
    "is_active",
    "role"
  ],
  "properties": {
    "role": {
      "type": "string",
      "format": "uuid",
      "example": "f1968726-1dca-42d4-a4dc-80cab99e2b6c",
      "description": "The role public ID that will be granted to to invitee on acceptance."
    },
    "email": {
      "type": "string",
      "example": "example@email.com",
      "description": "The email address of the invitee."
    },
    "is_active": {
      "type": "boolean",
      "example": true,
      "description": "The active status of the invitation. is_active of true indicates that the invitation is still waiting to be accepted. Invitations are considered inactive when accepted or revoked.\n"
    }
  }
}

{
  "type": "object",
  "required": [
    "email",
    "role"
  ],
  "properties": {
    "role": {
      "format": "uuid",
      "example": "f1968726-1dca-42d4-a4dc-80cab99e2b6c",
      "description": "The role public ID that will be granted to to invitee on acceptance."
    },
    "email": {
      "type": "string",
      "example": "example@email.com",
      "description": "The email address of the invitee."
    }
  }
}

{
  "type": "object",
  "required": [
    "type",
    "attributes"
  ],
  "properties": {
    "type": {
      "enum": [
        "org_invitation"
      ],
      "type": "string"
    },
    "attributes": {
      "$ref": "#/components/schemas/OrgInvitationPostAttributes"
    },
    "relationships": {
      "type": "object",
      "properties": {
        "org": {
          "$ref": "#/components/schemas/Relationship"
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "member_role": {
      "$ref": "#/components/schemas/MemberRoleRelationship"
    }
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "Collaborator",
      "description": "The display name of the organization role."
    }
  }
}

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "My Org",
      "maxLength": 60,
      "minLength": 1,
      "description": "The display name of the organization."
    }
  }
}

{
  "type": "object",
  "required": [
    "type",
    "id",
    "attributes"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "59d6d97e-3106-4ebb-b608-352fad9c5b34",
      "description": "The Snyk ID of the organization."
    },
    "type": {
      "$ref": "#/components/schemas/Types"
    },
    "attributes": {
      "$ref": "#/components/schemas/OrgAttributes"
    },
    "relationships": {
      "$ref": "#/components/schemas/OrgRelationships"
    }
  }
}

{
  "enum": [
    "organization"
  ],
  "type": "string",
  "example": "organization"
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/Org"
    },
    "links": {
      "$ref": "#/components/schemas/SelfLink"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}

{
  "type": "object",
  "required": [
    "jsonapi",
    "data",
    "links"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrgWithRelationships"
      }
    },
    "links": {
      "$ref": "#/components/schemas/PaginatedLinks"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}

{
  "type": "object",
  "required": [
    "jsonapi",
    "data",
    "links"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Org"
      }
    },
    "links": {
      "$ref": "#/components/schemas/PaginatedLinks"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "type": {
          "$ref": "#/components/schemas/Types"
        },
        "attributes": {
          "$ref": "#/components/schemas/OrgUpdateAttributes"
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "id",
        "type"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2"
        },
        "type": {
          "$ref": "#/components/schemas/Types"
        },
        "attributes": {
          "$ref": "#/components/schemas/OrgAttributes"
        },
        "relationships": {
          "$ref": "#/components/schemas/OrgRelationships"
        }
      },
      "description": "org resource object"
    },
    "links": {
      "$ref": "#/components/schemas/SelfLink"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}

{
  "type": "object",
  "required": [
    "name",
    "type",
    "url",
    "version"
  ],
  "properties": {
    "url": {
      "type": "string",
      "example": "pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0",
      "description": "The purl of the package"
    },
    "name": {
      "type": "string",
      "example": "spring-core",
      "description": "The package’s name"
    },
    "type": {
      "type": "string",
      "example": "maven",
      "description": "The package type or protocol"
    },
    "version": {
      "type": "string",
      "example": "1.0.0",
      "description": "The version of the package"
    },
    "namespace": {
      "type": "string",
      "example": "org.springframework",
      "description": "A name prefix, such as a maven group id or docker image owner"
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "example": "pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0",
      "description": "The purl of the package"
    },
    "name": {
      "type": "string",
      "example": "woodstox-core",
      "description": "The package’s name"
    },
    "type": {
      "type": "string",
      "example": "maven",
      "description": "The package type or protocol"
    },
    "version": {
      "type": "string",
      "example": "5.0.0",
      "description": "The version of the package"
    },
    "namespace": {
      "type": "string",
      "example": "com.fasterxml.woodstox",
      "description": "A name prefix, such as a maven group id or docker image owner"
    }
  }
}

{
  "type": "object",
  "properties": {
    "package": {
      "$ref": "#/components/schemas/PackageMeta"
    }
  }
}

{
  "type": "object",
  "example": {
    "last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
    "next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K",
    "first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K"
  },
  "properties": {
    "last": {
      "$ref": "#/components/schemas/LinkProperty"
    },
    "next": {
      "$ref": "#/components/schemas/LinkProperty"
    },
    "prev": {
      "$ref": "#/components/schemas/LinkProperty"
    },
    "self": {
      "$ref": "#/components/schemas/LinkProperty"
    },
    "first": {
      "$ref": "#/components/schemas/LinkProperty"
    }
  }
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "type",
        "id",
        "attributes",
        "relationships"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "example": "331ede0a-de94-456f-b788-166caeca58bf",
          "description": "The Resource ID."
        },
        "type": {
          "enum": [
            "project"
          ],
          "type": "string",
          "description": "The Resource type."
        },
        "attributes": {
          "type": "object",
          "properties": {
            "tags": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "key": {
                    "type": "string",
                    "example": "tag-key"
                  },
                  "value": {
                    "type": "string",
                    "example": "tag-value"
                  }
                }
              },
              "example": [
                {
                  "key": "tag-key",
                  "value": "tag-value"
                }
              ]
            },
            "lifecycle": {
              "type": "array",
              "items": {
                "enum": [
                  "production",
                  "development",
                  "sandbox"
                ],
                "type": "string"
              },
              "example": [
                "production"
              ]
            },
            "environment": {
              "type": "array",
              "items": {
                "enum": [
                  "frontend",
                  "backend",
                  "internal",
                  "external",
                  "mobile",
                  "saas",
                  "onprem",
                  "hosted",
                  "distributed"
                ],
                "type": "string"
              },
              "example": [
                "external",
                "hosted"
              ]
            },
            "test_frequency": {
              "enum": [
                "daily",
                "weekly",
                "never"
              ],
              "type": "string",
              "example": "daily",
              "description": "Test frequency of a project. Also controls when automated PRs may be created."
            },
            "business_criticality": {
              "type": "array",
              "items": {
                "enum": [
                  "critical",
                  "high",
                  "medium",
                  "low"
                ],
                "type": "string"
              },
              "example": [
                "medium"
              ]
            }
          }
        },
        "relationships": {
          "type": "object",
          "properties": {
            "owner": {
              "type": "object",
              "required": [
                "data"
              ],
              "properties": {
                "data": {
                  "type": "object",
                  "required": [
                    "type",
                    "id"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid",
                      "example": "331ede0a-de94-456f-b788-166caeca58bf",
                      "nullable": true,
                      "description": "The public ID of the user that owns the project"
                    },
                    "type": {
                      "enum": [
                        "user"
                      ],
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

{
  "enum": [
    "aix/ppc64",
    "android/386",
    "android/amd64",
    "android/arm",
    "android/arm/v5",
    "android/arm/v6",
    "android/arm/v7",
    "android/arm64",
    "android/arm64/v8",
    "darwin/amd64",
    "darwin/arm",
    "darwin/arm/v5",
    "darwin/arm/v6",
    "darwin/arm/v7",
    "darwin/arm64",
    "darwin/arm64/v8",
    "dragonfly/amd64",
    "freebsd/386",
    "freebsd/amd64",
    "freebsd/arm",
    "freebsd/arm/v5",
    "freebsd/arm/v6",
    "freebsd/arm/v7",
    "illumos/amd64",
    "ios/arm64",
    "ios/arm64/v8",
    "js/wasm",
    "linux/386",
    "linux/amd64",
    "linux/arm",
    "linux/arm/v5",
    "linux/arm/v6",
    "linux/arm/v7",
    "linux/arm64",
    "linux/arm64/v8",
    "linux/loong64",
    "linux/mips",
    "linux/mipsle",
    "linux/mips64",
    "linux/mips64le",
    "linux/ppc64",
    "linux/ppc64le",
    "linux/riscv64",
    "linux/s390x",
    "linux/x86_64",
    "netbsd/386",
    "netbsd/amd64",
    "netbsd/arm",
    "netbsd/arm/v5",
    "netbsd/arm/v6",
    "netbsd/arm/v7",
    "openbsd/386",
    "openbsd/amd64",
    "openbsd/arm",
    "openbsd/arm/v5",
    "openbsd/arm/v6",
    "openbsd/arm/v7",
    "openbsd/arm64",
    "openbsd/arm64/v8",
    "plan9/386",
    "plan9/amd64",
    "plan9/arm",
    "plan9/arm/v5",
    "plan9/arm/v6",
    "plan9/arm/v7",
    "solaris/amd64",
    "windows/386",
    "windows/amd64",
    "windows/arm",
    "windows/arm/v5",
    "windows/arm/v6",
    "windows/arm/v7",
    "windows/arm64",
    "windows/arm64/v8"
  ],
  "type": "string",
  "example": "linux/amd64"
}

{
  "type": "object",
  "example": {
    "id": "SNYK-DEBIAN8-CURL-358558",
    "type": "rule",
    "source": "snyk"
  },
  "required": [
    "id",
    "type",
    "source"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 1024,
      "minLength": 1
    },
    "url": {
      "type": "string",
      "format": "uri",
      "maxLength": 4096,
      "minLength": 1,
      "description": "An optional URL for this problem."
    },
    "type": {
      "$ref": "#/components/schemas/ProblemTypeDef"
    },
    "source": {
      "type": "string",
      "example": "CVE",
      "maxLength": 64,
      "minLength": 1
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "When this problem was last updated."
    },
    "disclosed_at": {
      "type": "string",
      "format": "date-time",
      "description": "When this problem was disclosed to the public."
    },
    "discovered_at": {
      "type": "string",
      "format": "date-time",
      "description": "When this problem was first discovered."
    }
  }
}

{
  "enum": [
    "rule",
    "vulnerability"
  ],
  "type": "string"
}

{
  "type": "object",
  "required": [
    "name",
    "type",
    "target_file",
    "target_reference",
    "origin",
    "created",
    "status",
    "read_only",
    "settings"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "snyk/goof",
      "description": "Project name."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "example": "tag-key"
          },
          "value": {
            "type": "string",
            "example": "tag-value"
          }
        }
      },
      "example": [
        {
          "key": "tag-key",
          "value": "tag-value"
        }
      ]
    },
    "type": {
      "type": "string",
      "example": "maven",
      "description": "The package manager of the project."
    },
    "origin": {
      "type": "string",
      "example": "github",
      "description": "The origin the project was added from."
    },
    "status": {
      "enum": [
        "active",
        "inactive"
      ],
      "type": "string",
      "example": "active",
      "description": "Describes if a project is currently monitored or it is de-activated."
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "example": "2021-05-29T09:50:54.014Z",
      "description": "The date that the project was created on"
    },
    "settings": {
      "$ref": "#/components/schemas/ProjectSettings"
    },
    "lifecycle": {
      "type": "array",
      "items": {
        "enum": [
          "production",
          "development",
          "sandbox"
        ],
        "type": "string"
      },
      "example": [
        "production"
      ]
    },
    "read_only": {
      "type": "boolean",
      "description": "Whether the project is read-only"
    },
    "build_args": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/YarnBuildArgs"
        },
        {
          "$ref": "#/components/schemas/ContainerBuildArgs"
        },
        {
          "$ref": "#/components/schemas/NugetBuildArgs"
        }
      ]
    },
    "environment": {
      "type": "array",
      "items": {
        "enum": [
          "frontend",
          "backend",
          "internal",
          "external",
          "mobile",
          "saas",
          "onprem",
          "hosted",
          "distributed"
        ],
        "type": "string"
      },
      "example": [
        "external",
        "hosted"
      ]
    },
    "target_file": {
      "type": "string",
      "example": "package.json",
      "description": "Path within the target to identify a specific file/directory/image etc. when scanning just part  of the target, and not the entity."
    },
    "target_runtime": {
      "type": "string",
      "description": "Dotnet Target, for relevant projects"
    },
    "target_reference": {
      "type": "string",
      "example": "main",
      "description": "The additional information required to resolve which revision of the resource should be scanned."
    },
    "business_criticality": {
      "type": "array",
      "items": {
        "enum": [
          "critical",
          "high",
          "medium",
          "low"
        ],
        "type": "string"
      },
      "example": [
        "medium"
      ]
    }
  }
}