Contributors

Currently, we define contributors with static YAML documents. The following schema describes the allowed and the required values.

Schema documentation
Example
JSON Schema

idstring (uuid)
required
ID of the contributor. It has to be globally unique.
namestring
required
Name of the contributor.
descriptionstring
A short description of the contributor.
customerIdstring (uuid)
required
ID of the organization in the mStudio, the contributor belongs to. The mapping of contributors to organizations is 1:1.
stateobject
required
State of the Contributor.
- disabledboolean
emailstring (email)
required
Email address of the contributor for support.
phonestring (phone)
Phone number of the contributor for support.

id: f0f86186-0a5a-45b2-aa33-502777496347
name: mittwald
description: Germany based web hoster and contributor of extensions for the mStudio.
customerId: f0f86186-0a5a-45b2-aa33-502777496347
state:
  disabled: false
email: email@mittwald.example
phone: "+491701234567"

{
  "type": "object",
  "required": [
    "id",
    "name",
    "customerId",
    "state",
    "email"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the contributor. It has to be globally unique."
    },
    "name": {
      "type": "string",
      "description": "Name of the contributor.",
      "example": "mittwald"
    },
    "description": {
      "type": "string",
      "description": "A short description of the contributor.",
      "example": "Germany based web hoster and contributor of extensions for the mStudio."
    },
    "customerId": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the organization in the mStudio, the contributor belongs to. The mapping of contributors to organizations is 1:1."
    },
    "state": {
      "type": "object",
      "description": "State of the Contributor.",
      "example": {
        "disabled": false
      },
      "properties": {
        "disabled": {
          "type": "boolean"
        }
      }
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address of the contributor for support."
    },
    "phone": {
      "type": "string",
      "format": "phone",
      "example": "+491701234567",
      "description": "Phone number of the contributor for support."
    }
  }
}