organization-custom-repository-role-create-schema

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
name	string	The name of the custom role.
description	string	A short description about who this role is for or what permissions it grants.
base_role	string	The system role from which this role inherits permissions.
permissions	array	A list of additional permissions included in this role.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/organization-custom-repository-role-create-schema",
  "title": "organization-custom-repository-role-create-schema",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the custom role.",
      "type": "string"
    },
    "description": {
      "description": "A short description about who this role is for or what permissions it grants.",
      "type": "string",
      "nullable": true
    },
    "base_role": {
      "type": "string",
      "description": "The system role from which this role inherits permissions.",
      "enum": [
        "read",
        "triage",
        "write",
        "maintain"
      ]
    },
    "permissions": {
      "description": "A list of additional permissions included in this role.",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "name",
    "base_role",
    "permissions"
  ]
}