Authors

Configuration Structure

The author configuration supports both individual authors and organizations:

author:
  name: John Doe
  email: john@example.com

author:
  name: John Doe
  email: john@example.com
  url: https://johndoe.dev
  organization: Example Corp
  contributors:
    - name: Jane Smith
      email: jane@example.com
    - name: Bob Wilson
      organization: Another Corp

author:
  name: Example Corporation
  url: https://example.com
  organization: Example Corp
  contributors:
    - name: Development Team
      email: dev@example.com

API Reference

Parameters
JSON Schema

string

required

Name of the author or organization maintaining the workflow.

string

Contact email address for the author or organization.

string

Website or profile URL where users can find more information about the author.

string

Name of the organization associated with the workflow or author.

array

List of additional contributors to the workflow. Each contributor can have their own name, email, url, and organization fields.

https://compozy.dev/schemas/authors.json

{
  "type": "object",
  "properties": {
    "author": {
      "type": "object",
      "required": ["name"],
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the author or organization"
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "Contact email address"
        },
        "url": {
          "type": "string",
          "format": "uri",
          "description": "Website or profile URL"
        },
        "organization": {
          "type": "string",
          "description": "Associated organization name"
        },
        "contributors": {
          "type": "array",
          "items": {
            "type": "object",
            "required": ["name"],
            "properties": {
              "name": {
                "type": "string",
                "description": "Contributor's name"
              },
              "email": {
                "type": "string",
                "format": "email",
                "description": "Contributor's email"
              },
              "url": {
                "type": "string",
                "format": "uri",
                "description": "Contributor's website or profile"
              },
              "organization": {
                "type": "string",
                "description": "Contributor's organization"
              }
            }
          }
        }
      }
    }
  }
}

Getting Started

Core Concepts

Configuration Structure

API Reference

​Configuration Structure

​API Reference

Configuration Structure

API Reference