Stainless · Schema

ProjectBranch

A project branch names a line of development for a project. Like a Git branch, it points to a Git commit with a set of config files. In addition, a project branch also points to a set of custom code changes, corresponding to Git branches in the staging repos.

Code GenerationDocumentationDeveloper ExperienceMCPPlatformSDKTerraformSDK GenerationOpenAPI

Properties

Name Type Description
object string
branch string Branch name
org string
project string Project name
config_commit object A Git commit that points to the latest set of config files on a given branch.
latest_build object
View JSON Schema on GitHub

JSON Schema

stainless-project-branch-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/stainless/main/json-schema/stainless-project-branch-schema.json",
  "title": "ProjectBranch",
  "description": "A project branch names a line of development for a project. Like a Git\nbranch, it points to a Git commit with a set of config files. In addition, a\nproject branch also points to a set of custom code changes, corresponding to\nGit branches in the staging repos.",
  "x-generated": "2026-10-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/stainless-projects-api-openapi.yml#/components/schemas/ProjectBranch",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "enum": [
        "project_branch"
      ]
    },
    "branch": {
      "type": "string",
      "description": "Branch name"
    },
    "org": {
      "type": "string"
    },
    "project": {
      "type": "string",
      "description": "Project name"
    },
    "config_commit": {
      "type": "object",
      "properties": {
        "sha": {
          "type": "string"
        },
        "repo": {
          "type": "object",
          "properties": {
            "host": {
              "type": "string"
            },
            "owner": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "branch": {
              "type": "string"
            }
          },
          "required": [
            "host",
            "owner",
            "name",
            "branch"
          ]
        },
        "tree_oid": {
          "type": [
            "string",
            "null"
          ]
        },
        "stats": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "additions": {
              "type": "integer",
              "minimum": 0
            },
            "deletions": {
              "type": "integer",
              "minimum": 0
            },
            "total": {
              "type": "integer",
              "minimum": 0
            }
          },
          "required": [
            "additions",
            "deletions",
            "total"
          ]
        }
      },
      "required": [
        "sha",
        "repo",
        "tree_oid",
        "stats"
      ],
      "description": "A Git commit that points to the latest set of config files on a given\nbranch."
    },
    "latest_build": {
      "oneOf": [
        {
          "$ref": "#/$defs/Build"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "object",
    "branch",
    "org",
    "project",
    "config_commit",
    "latest_build"
  ],
  "$defs": {
    "Build": {
      "type": "object",
      "properties": {
        "object": {
          "type": "string",
          "enum": [
            "build"
          ]
        },
        "id": {
          "type": "string",
          "description": "Build ID"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "project": {
          "type": "string"
        },
        "org": {
          "type": "string"
        },
        "config_commit": {
          "type": "string"
        },
        "documented_spec": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "content"
                  ]
                },
                "content": {
                  "type": "string"
                }
              },
              "required": [
                "type",
                "content"
              ]
            },
            {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "url"
                  ]
                },
                "url": {
                  "type": "string"
                },
                "expires": {
                  "type": "string",
                  "format": "date-time"
                }
              },
              "required": [
                "type",
                "url",
                "expires"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "targets": {
          "type": "object",
          "properties": {
            "node": {
              "$ref": "#/$defs/BuildTarget"
            },
            "typescript": {
              "$ref": "#/$defs/BuildTarget"
            },
            "python": {
              "$ref": "#/$defs/BuildTarget"
            },
            "go": {
              "$ref": "#/$defs/BuildTarget"
            },
            "java": {
              "$ref": "#/$defs/BuildTarget"
            },
            "kotlin": {
              "$ref": "#/$defs/BuildTarget"
            },
            "ruby": {
              "$ref": "#/$defs/BuildTarget"
            },
            "terraform": {
              "$ref": "#/$defs/BuildTarget"
            },
            "cli": {
              "$ref": "#/$defs/BuildTarget"
            },
            "php": {
              "$ref": "#/$defs/BuildTarget"
            },
            "csharp": {
              "$ref": "#/$defs/BuildTarget"
            },
            "sql": {
              "$ref": "#/$defs/BuildTarget"
            },
            "openapi": {
              "$ref": "#/$defs/BuildTarget"
            }
          },
          "additionalProperties": false
        }
      },
      "required": [
        "object",
        "id",
        "updated_at",
        "created_at",
        "project",
        "org",
        "config_commit",
        "documented_spec",
        "targets"
      ]
    },
    "BuildTarget": {
      "type": "object",
      "properties": {
        "object": {
          "type": "string",
          "enum": [
            "build_target"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "not_started",
            "codegen",
            "postgen",
            "completed"
          ]
        },
        "commit": {
          "$ref": "#/$defs/CommitStep"
        },
        "lint": {
          "$ref": "#/$defs/CheckStep"
        },
        "test": {
          "$ref": "#/$defs/CheckStep"
        },
        "build": {
          "$ref": "#/$defs/CheckStep"
        },
        "install_url": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "object",
        "status",
        "commit",
        "install_url"
      ]
    },
    "CheckConclusion": {
      "type": "string",
      "enum": [
        "success",
        "failure",
        "skipped",
        "cancelled",
        "action_required",
        "neutral",
        "timed_out"
      ]
    },
    "CheckStep": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "not_started"
              ]
            }
          },
          "required": [
            "status"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "waiting"
              ]
            },
            "url": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "status",
            "url"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "queued"
              ]
            },
            "url": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "status",
            "url"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "in_progress"
              ]
            },
            "url": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "status",
            "url"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "completed"
              ]
            },
            "completed": {
              "type": "object",
              "properties": {
                "conclusion": {
                  "$ref": "#/$defs/CheckConclusion"
                },
                "url": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "conclusion",
                "url"
              ],
              "description": "deprecated"
            },
            "conclusion": {
              "$ref": "#/$defs/CheckConclusion"
            },
            "url": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "status",
            "completed",
            "conclusion",
            "url"
          ]
        }
      ]
    },
    "Commit": {
      "type": "object",
      "properties": {
        "sha": {
          "type": "string"
        },
        "repo": {
          "type": "object",
          "properties": {
            "host": {
              "type": "string"
            },
            "owner": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "branch": {
              "type": "string"
            }
          },
          "required": [
            "host",
            "owner",
            "name",
            "branch"
          ]
        },
        "tree_oid": {
          "type": [
            "string",
            "null"
          ]
        },
        "stats": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "additions": {
              "type": "integer",
              "minimum": 0
            },
            "deletions": {
              "type": "integer",
              "minimum": 0
            },
            "total": {
              "type": "integer",
              "minimum": 0
            }
          },
          "required": [
            "additions",
            "deletions",
            "total"
          ]
        }
      },
      "required": [
        "sha",
        "repo",
        "tree_oid",
        "stats"
      ]
    },
    "CommitConclusion": {
      "type": "string",
      "enum": [
        "error",
        "warning",
        "note",
        "success",
        "merge_conflict",
        "upstream_merge_conflict",
        "fatal",
        "payment_required",
        "cancelled",
        "timed_out",
        "noop",
        "version_bump"
      ]
    },
    "CommitStep": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "not_started"
              ]
            }
          },
          "required": [
            "status"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "waiting"
              ]
            }
          },
          "required": [
            "status"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "queued"
              ]
            }
          },
          "required": [
            "status"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "in_progress"
              ]
            }
          },
          "required": [
            "status"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "completed"
              ]
            },
            "completed": {
              "type": "object",
              "properties": {
                "conclusion": {
                  "$ref": "#/$defs/CommitConclusion"
                },
                "merge_conflict_pr": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "number": {
                      "type": "number"
                    },
                    "repo": {
                      "type": "object",
                      "properties": {
                        "host": {
                          "type": "string"
                        },
                        "owner": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "host",
                        "owner",
                        "name"
                      ]
                    }
                  },
                  "required": [
                    "number",
                    "repo"
                  ]
                },
                "commit": {
                  "oneOf": [
                    {
                      "$ref": "#/$defs/Commit"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "completed_at": {
                  "type": "string",
                  "format": "date-time"
                }
              },
              "required": [
                "conclusion",
                "merge_conflict_pr",
                "commit",
                "completed_at"
              ],
              "description": "deprecated"
            },
            "conclusion": {
              "$ref": "#/$defs/CommitConclusion"
            },
            "merge_conflict_pr": {
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "number": {
                  "type": "number"
                },
                "repo": {
                  "type": "object",
                  "properties": {
                    "host": {
                      "type": "string"
                    },
                    "owner": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "host",
                    "owner",
                    "name"
                  ]
                }
              },
              "required": [
                "number",
                "repo"
              ]
            },
            "commit": {
              "oneOf": [
                {
                  "$ref": "#/$defs/Commit"
                },
                {
                  "type": "null"
                }
              ]
            },
            "completed_at": {
              "type": "string",
              "format": "date-time"
            }
          },
          "required": [
            "status",
            "completed",
            "conclusion",
            "merge_conflict_pr",
            "commit",
            "completed_at"
          ]
        }
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/stainless-project-branch"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.