Skip to content

epicSchema

type: object

a large creative endeavour that the user has undertaken; The user can work on one or more projects as a part of an epic.

id

type: string
optional? yes

an identifier for the epic; In implementations, this can be used as a key to find the logo for the epic.

name

type: string

the name of the epic

url

type: urlSchema
optional? yes

the public facing URL to access this epic homepage; This should be a place where more information about the epic can be found.

summary

type: string
optional? yes

a short description or introduction of the epic; This is used where space is limited such as a résumé.

description

type: string
optional? yes

long-form description of the epic; This is used where space is not constrained.

projects

type: array
optional? yes

a list of projects that are part of this epic

projects[idx]

type: projectSchema

a creative endeavour undertaken as a part of a larger epic