Perforce · Schema

Project

A project in Helix Swarm, grouping branches, members, and review settings.

Properties

Name	Type	Description
id	string	The project identifier.
name	string	The project display name.
description	string	The project description.
members	array	List of project member usernames.
owners	array	List of project owner usernames.
subgroups	array	List of associated Perforce groups.
branches	array	Branch definitions for the project.
deleted	boolean	Whether the project has been deleted.
deploy	object	Deploy configuration for the project.
emailFlags	object	Email notification settings.
jobview	string	A Perforce jobview expression for the project.
minimumUpVotes	integer	Minimum number of up votes required for approval.
private	boolean	Whether the project is private.
retainDefaultReviewers	boolean	Whether to retain default reviewers on review updates.
tests	object	Test configuration for the project.
workflow	string	The workflow identifier associated with the project.
defaults	object	Default settings for the project.
readme	string	The project readme content.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Project",
  "title": "Project",
  "type": "object",
  "description": "A project in Helix Swarm, grouping branches, members, and review settings.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The project identifier.",
      "example": "abc123"
    },
    "name": {
      "type": "string",
      "description": "The project display name.",
      "example": "Example Title"
    },
    "description": {
      "type": "string",
      "description": "The project description.",
      "example": "A sample description."
    },
    "members": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of project member usernames.",
      "example": []
    },
    "owners": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of project owner usernames.",
      "example": []
    },
    "subgroups": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of associated Perforce groups.",
      "example": []
    },
    "branches": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "paths": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "moderators": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "description": "Branch definitions for the project.",
      "example": []
    },
    "deleted": {
      "type": "boolean",
      "description": "Whether the project has been deleted.",
      "example": true
    },
    "deploy": {
      "type": "object",
      "description": "Deploy configuration for the project.",
      "example": "example_value"
    },
    "emailFlags": {
      "type": "object",
      "description": "Email notification settings.",
      "example": "[email protected]"
    },
    "jobview": {
      "type": "string",
      "description": "A Perforce jobview expression for the project.",
      "example": "example_value"
    },
    "minimumUpVotes": {
      "type": "integer",
      "description": "Minimum number of up votes required for approval.",
      "example": 10
    },
    "private": {
      "type": "boolean",
      "description": "Whether the project is private.",
      "example": true
    },
    "retainDefaultReviewers": {
      "type": "boolean",
      "description": "Whether to retain default reviewers on review updates.",
      "example": true
    },
    "tests": {
      "type": "object",
      "description": "Test configuration for the project.",
      "example": "example_value"
    },
    "workflow": {
      "type": "string",
      "description": "The workflow identifier associated with the project.",
      "example": "example_value"
    },
    "defaults": {
      "type": "object",
      "description": "Default settings for the project.",
      "example": "example_value"
    },
    "readme": {
      "type": "string",
      "description": "The project readme content.",
      "example": "example_value"
    }
  }
}