GafaelfawrScope

pydantic model phalanx.models.environments.GafaelfawrScope

A Gafaelfawr scope and its associated groups.

Parameters:

data (Any) –

Show JSON schema

{
   "title": "GafaelfawrScope",
   "description": "A Gafaelfawr scope and its associated groups.",
   "type": "object",
   "properties": {
      "scope": {
         "title": "Scope",
         "type": "string"
      },
      "groups": {
         "items": {
            "anyOf": [
               {
                  "type": "string"
               },
               {
                  "$ref": "#/$defs/GafaelfawrGitHubGroup"
               }
            ]
         },
         "title": "Groups",
         "type": "array"
      }
   },
   "$defs": {
      "GafaelfawrGitHubGroup": {
         "description": "A group based on a GitHub team.",
         "properties": {
            "github": {
               "$ref": "#/$defs/GafaelfawrGitHubTeam"
            }
         },
         "required": [
            "github"
         ],
         "title": "GafaelfawrGitHubGroup",
         "type": "object"
      },
      "GafaelfawrGitHubTeam": {
         "description": "Designates a GitHub team for use as a Gafaelfawr group.",
         "properties": {
            "organization": {
               "title": "Organization",
               "type": "string"
            },
            "team": {
               "title": "Team",
               "type": "string"
            }
         },
         "required": [
            "organization",
            "team"
         ],
         "title": "GafaelfawrGitHubTeam",
         "type": "object"
      }
   },
   "required": [
      "scope",
      "groups"
   ]
}

Fields:

• groups (list[str | phalanx.models.environments.GafaelfawrGitHubGroup])

• scope (str)

field groups: list[str | GafaelfawrGitHubGroup] [Required]

List of groups that grant that scope.

field scope: str [Required]

Name of the scope.

groups_as_rst()

Format the groups as a list of reStructuredText elements.

Return type:

list[str]