Contributoren

Contributoren werden derzeit über statische YAML-Dokumente definiert. Die benötigten und erlaubten Attribute sind in folgendem Schema beschrieben.

Schema-Dokumentation

• idstring (uuid)

  required

  ID des Contributoren. Muss global eindeutig sein.

• namestring

  required

  Name des Contributoren.

• descriptionstring

  Kurzbeschreibung des Contributoren.

• customerIdstring (uuid)

  required

  ID der Organisation im mStudio, zu der der Contributor gehört. Ein Contributor hat ein 1:1 Verhältnis zu einer Organisation

• stateobject

  required

  Status des Contributoren.

  • disabledboolean
• emailstring (email)

  required

  E-Mail-Adresse des Contributoren, die für Support Zwecke genutzt werden kann.

• phonestring (phone)

  Telefonnummer des Contributoren, die für Support Zwecke genutzt werden kann.

Beispiel

id: f0f86186-0a5a-45b2-aa33-502777496347
name: mittwald
description: Deutscher Web-Hoster und Contributor von Extensions für das mStudio.
customerId: f0f86186-0a5a-45b2-aa33-502777496347
state:
  disabled: false
email: email@mittwald.example
phone: "+491701234567"

JSON Schema

{
  "type": "object",
  "required": [
    "id",
    "name",
    "customerId",
    "state",
    "email"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "ID des Contributoren. Muss global eindeutig sein."
    },
    "name": {
      "type": "string",
      "description": "Name des Contributoren.",
      "example": "mittwald"
    },
    "description": {
      "type": "string",
      "description": "Kurzbeschreibung des Contributoren.",
      "example": "Deutscher Web-Hoster und Contributor von Extensions für das mStudio."
    },
    "customerId": {
      "type": "string",
      "format": "uuid",
      "description": "ID der Organisation im mStudio, zu der der Contributor gehört. Ein Contributor hat ein 1:1 Verhältnis zu einer Organisation"
    },
    "state": {
      "type": "object",
      "description": "Status des Contributoren.",
      "example": {
        "disabled": false
      },
      "properties": {
        "disabled": {
          "type": "boolean"
        }
      }
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "E-Mail-Adresse des Contributoren, die für Support Zwecke genutzt werden kann."
    },
    "phone": {
      "type": "string",
      "format": "phone",
      "example": "+491701234567",
      "description": "Telefonnummer des Contributoren, die für Support Zwecke genutzt werden kann."
    }
  }
}