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
homepagestring
Homepage of the Contributor
emailstring (email)
required
Email address of the contributor for support.
phonestring (phone)
Phone number of the contributor for support.
imprintone of 2 alternatives
- Alternativeobject
  - textstring
    required
- Alternativeobject
  - urlstring
    required

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
homepage: https://mittwald.de/
email: email@mittwald.example
phone: "+49123456789"
imprint:
  text: >
    Innovate Solutions GmbH & Co. KG

    Tech Park 8

    10115 Berlin

    Phone: +49-30-1234-567

    Fax: +49-30-1234-568

    Commercial Register No: HRA 7789, Local Court Berlin (Charlottenburg)

    VAT ID No: DE987654321

    General Partner: Alpha Management GmbH, Local Court Berlin (Charlottenburg),
    HRB 24680

    Represented by the Managing Directors: Dr. Lena Müller, David Schmidt

{
  "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"
        }
      }
    },
    "homepage": {
      "type": "string",
      "description": "Homepage of the Contributor",
      "example": "https://mittwald.de/"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address of the contributor for support."
    },
    "phone": {
      "type": "string",
      "format": "phone",
      "example": "+49123456789",
      "description": "Phone number of the contributor for support."
    },
    "imprint": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "text": {
              "type": "string",
              "example": "Innovate Solutions GmbH & Co. KG\nTech Park 8\n10115 Berlin\nPhone: +49-30-1234-567\nFax: +49-30-1234-568\nCommercial Register No: HRA 7789, Local Court Berlin (Charlottenburg)\nVAT ID No: DE987654321\nGeneral Partner: Alpha Management GmbH, Local Court Berlin (Charlottenburg), HRB 24680\nRepresented by the Managing Directors: Dr. Lena Müller, David Schmidt\n"
            }
          },
          "required": [
            "text"
          ]
        },
        {
          "type": "object",
          "properties": {
            "url": {
              "type": "string"
            }
          },
          "required": [
            "url"
          ]
        }
      ]
    }
  }
}