Team Membership

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
url	string
role	string	The role of the user in the team.
state	string	The state of the user's membership in the team.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/team-membership",
  "title": "Team Membership",
  "description": "Team Membership",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri"
    },
    "role": {
      "description": "The role of the user in the team.",
      "enum": [
        "member",
        "maintainer"
      ],
      "default": "member",
      "example": "member",
      "type": "string"
    },
    "state": {
      "description": "The state of the user's membership in the team.",
      "type": "string",
      "enum": [
        "active",
        "pending"
      ]
    }
  },
  "required": [
    "role",
    "state",
    "url"
  ]
}