schema.js

const sections = [
  {
    title: 'Person',
    desc: '',
    endpoints: [
      {
        // get
        name: 'Get the current person\'s information',
        path: '/api/current_person',
        rawPath: '/api/current_person',
        method: 'GET'
      },
    ]
  },
  {
    title: 'Accounts',
    note: 'Zube Organizations are referred to as <code class="inline">accounts</code> in the Zube API.',
    endpoints: [
      // Accounts
      {
        // index
        method: 'GET',
        name: 'Get a list of accounts',
        path: '/api/accounts',
        rawPath: '/api/accounts',
      },
      {
        // read
        method: 'GET',
        name: 'Get an account',
        path: '/api/accounts/:account_id',
        rawPath: '/api/accounts/:id',
      },
      // Account Admin Members
      {
        // index
        path: '/api/accounts/:account_id/admin_members',
        rawPath: '/api/accounts/:id/admin_members',
        method: 'GET',
        name: 'Get a list of account admins'
      },
      {
        // create
        path: '/api/accounts/:account_id/admin_members',
        rawPath: '/api/accounts/:id/admin_members',
        method: 'POST',
        name: 'Create an account admin',
        formData: [
          { name: 'person_id', type: 'Integer', isRequired: true },
        ]
      },
      {
        // destroy
        path: '/api/accounts/:account_id/admin_members/:admin_member_id',
        rawPath: '/api/accounts/:id/admin_members/:person_id',
        method: 'DELETE',
        name: 'Remove an account admin'
      },
      // Account Members
      {
        // index
        path: '/api/accounts/:account_id/members',
        rawPath: '/api/accounts/:id/members',
        method: 'GET',
        name: 'Get a list of account members'
      },
      {
        // create
        path: '/api/accounts/:account_id/members',
        rawPath: '/api/accounts/:id/members',
        method: 'POST',
        name: 'Create an account member',
        formData: [
          { name: 'person_id', type: 'Integer', isRequired: true },
        ]
      },
      {
        // destroy
        path: '/api/accounts/:account_id/members/:member_id',
        rawPath: '/api/accounts/:id/members/:person_id',
        method: 'DELETE',
        name: 'Remove an account member'
      },
      // Account Projects
      {
        // index
        path: '/api/accounts/:account_id/projects',
        rawPath: '/api/accounts/:id/projects',
        method: 'GET',
        name: 'Get a list of projects for an account'
      },
    ]
  },
  {
    title: 'Cards',
    desc: '',
    endpoints: [
      {
        // index
        path: '/api/cards',
        rawPath: '/api/cards',
        method: 'GET',
        name: 'Get a list of cards',
        extendedQueryParams: [
            { name: 'where[created_after]', type: 'timestamp' },
            { name: 'where[updated_after]', type: 'timestamp' },
        ]
      },
      {
        // create
        path: '/api/cards',
        rawPath: '/api/cards',
        method: 'POST',
        name: 'Create a card',
        formData: [
          { name: 'title', type: 'String', isRequired: true },
          { name: 'project_id', type: 'Integer', isRequired: true },
          { name: 'sprint_id', type: 'Integer', isRequired: false },
          { name: 'github_issue[source_id]', type: 'Integer', isRequired: false, note: 'Required if <code class="inline">github_issue</code> object is sent' },
          { name: 'github_issue[milestone_id]', type: 'Integer', isRequired: false },
          { name: 'workspace_id', type: 'Integer', isRequired: false },
          { name: 'category_name', type: 'String', isRequired: false },
          { name: 'body', type: 'Text', isRequired: false },
          { name: 'label_ids', type: 'Array', isRequired: false, note: 'Array of <code class="inline">label.id</code>s' },
          { name: 'assignee_ids', type: 'Array', isRequired: false, note: 'Array of <code class="inline">assignee.id</code>s' },
          { name: 'points', type: 'Number', isRequired: false },
          { name: 'priority', type: 'Integer', isRequired: false, note: 'Must be one of <code class="inline">1</code>, <code class="inline">2</code>, <code class="inline">3</code>, <code class="inline">4</code>, <code class="inline">5</code>, or <code class="inline">null</code>' },
          { name: 'epic_id', type: 'Integer', isRequired: false },
        ]
      },
      {
        // read
        path: '/api/cards/:card_id',
        rawPath: '/api/cards/:id',
        method: 'GET',
        name: 'Get a card'
      },
      {
        // update
        path: '/api/cards/:card_id',
        rawPath: '/api/cards/:id',
        method: 'PUT',
        name: 'Update a card',
        formData: [
          { name: 'title', type: 'String', isRequired: true },
          { name: 'body', type: 'Text', isRequired: true },
          { name: 'label_ids', type: 'Array', isRequired: true, note: 'Array of <code class="inline">label.id</code>s' },
          { name: 'assignee_ids', type: 'Array', isRequired: true, note: 'Array of <code class="inline">assignee.id</code>s' },
          { name: 'state', type: 'String', isRequired: true, note: 'Only accepts <code class="inline">open</code> or <code class="inline">closed</code>' },
          { name: 'sprint_id', type: 'Integer', isRequired: true },
          { name: 'project_id', type: 'Integer', isRequired: true },
          { name: 'workspace_id', type: 'Integer', isRequired: true },
          { name: 'points', type: 'Number', isRequired: true },
          { name: 'priority', type: 'Integer', isRequired: true,  note: 'Must be one of <code class="inline">1</code>, <code class="inline">2</code>, <code class="inline">3</code>, <code class="inline">4</code>, <code class="inline">5</code>, or <code class="inline">null</code>' },
          { name: 'epic_id', type: 'Integer', isRequired: true },
          { name: 'github_issue[milestone_id]', type: 'Integer', isRequired: true },
        ]
      },
      {
        // archive
        path: '/api/cards/:card_id/archive',
        rawPath: '/api/cards/:id/archive',
        method: 'PUT',
        name: 'Archive a card',
        note: 'This endpoint does not take any data'
      },
      {
        // Move
        path: '/api/cards/:card_id/move',
        rawPath: '/api/cards/:id/move',
        method: 'PUT',
        name: 'Move a card',
        note: `To move a card to a column on a workspace, pass:
        <pre><code class="language-javascript">destination: {
          position: CARD_POSITION,
          type: "category",
          name: NAME_OF_CATEGORY,
          workspace_id: YOUR_WORKSPACE_ID
        }</code></pre>
                To move a card to a project's triage, pass:
                <pre><code class="language-javascript">destination: {
          position: CARD_POSITION,
          type: "project"
        }</code></pre>
        `,
        formData: [
          { name: 'destination[position]', type: 'Integer', isRequired: true },
          { name: 'destination[type]', type: 'String', isRequired: true, note: 'Only accepts <code class="inline">category</code> or <code class="inline">project</code>' },
          { name: 'destination[name]', type: 'Integer', isRequired: false, note: 'Name of the destination category.' },
          { name: 'destination[workspace_id]', type: 'Integer', isRequired: false, note: 'Required if sending <code class="inline">destination[type]</code> as <code class="inline">category</code>' },
        ]
      },
      {
        // Add a Card to a Source Repo
        path: '/api/cards/:card_id/add_to_source',
        rawPath: '/api/cards/:id/add_to_source',
        method: 'PUT',
        name: 'Add a card to a source repo',
        formData: [
          { name: 'source_id', type: 'Integer', isRequired: true, note: 'You cannot change the source for a card that already has a source' },
        ]
      },
      // Card Relations
      {
        // index
        path: '/api/card_relations',
        rawPath: '/api/card_relations',
        method: 'GET',
        name: 'Get a list of card relations'
      },
      {
        // create
        path: '/api/card_relations',
        rawPath: '/api/card_relations',
        method: 'POST',
        name: 'Create a card relationship',
        formData: [
          { name: 'card_id', type: 'Integer', isRequired: true },
          { name: 'linked_card_id', type: 'Integer', isRequired: true },
        ]
      },
      {
        // delete
        path: '/api/card_relations/:card_relation_id',
        rawPath: '/api/card_relations/:id',
        method: 'DELETE',
        name: 'Remove a card relationship'
      },
      // Card Comments
      {
        // index
        path: '/api/cards/:card_id/comments',
        rawPath: '/api/cards/:id/comments',
        method: 'GET',
        name: 'Get a list of card comments'
      },
      {
        // create
        path: '/api/cards/:card_id/comments',
        rawPath: '/api/cards/:id/comments',
        method: 'POST',
        name: 'Create a new card comment',
        formData: [
          { name: 'body', type: 'Text', isRequired: true },
        ]
      },
      {
        // update
        path: '/api/cards/:card_id/comments/:comment_id',
        rawPath: '/api/cards/:id/comments/:comment_id',
        method: 'PUT',
        name: 'Update a card comment',
        formData: [
          { name: 'body', type: 'Text', isRequired: true },
        ]
      },
      {
        // destroy
        path: '/api/cards/:card_id/comments/:comment_id',
        rawPath: '/api/cards/:id/comments/:comment_id',
        method: 'DELETE',
        name: 'Remove a card comment'
      },
      // Card Custom Fields
      // card_custom_field_dates
      {
        // index
        path: '/api/cards/:card_id/card_custom_field_dates',
        rawPath: '/api/cards/:id/card_custom_field_dates',
        method: 'GET',
        name: 'Get a list of card card custom field dates'
      },
      {
        // read
        path: '/api/cards/:card_id/card_custom_field_dates/:card_custom_field_date_id',
        rawPath: '/api/cards/:id/card_custom_field_dates/:card_custom_field_date_id',
        method: 'GET',
        name: 'Get a card custom field date',
      },
      {
        // create
        path: '/api/cards/:card_id/card_custom_field_dates',
        rawPath: '/api/cards/:id/card_custom_field_dates',
        method: 'POST',
        name: 'Create a new card custom field date',
        formData: [
          { name: 'custom_field_id', type: 'Integer', isRequired: true },
          { name: 'date', type: 'Timestamp', isRequired: true },
        ]
      },
      {
        // update
        path: '/api/cards/:card_id/card_custom_field_dates/:card_custom_field_date_id',
        rawPath: '/api/cards/:id/card_custom_field_dates/:card_custom_field_date_id',
        method: 'PUT',
        name: 'Update a card custom field date',
        formData: [
          { name: 'custom_field_id', type: 'Integer', isRequired: true },
          { name: 'date', type: 'Timestamp', isRequired: true },
        ]
      },
      {
        // destroy
        path: '/api/cards/:card_id/card_custom_field_dates/:card_custom_field_date_id',
        rawPath: '/api/cards/:id/card_custom_field_dates/:card_custom_field_date_id',
        method: 'DELETE',
        name: 'Remove a card custom field date'
      },

      // card_custom_field_numbers
      {
          // index
          path: '/api/cards/:card_id/card_custom_field_numbers',
          rawPath: '/api/cards/:id/card_custom_field_numbers',
          method: 'GET',
          name: 'Get a list of card card custom field numbers'
      },
      {
          // read
          path: '/api/cards/:card_id/card_custom_field_numbers/:card_custom_field_number_id',
          rawPath: '/api/cards/:id/card_custom_field_numbers/:card_custom_field_number_id',
          method: 'GET',
          name: 'Get a card custom field number',
      },
      {
          // create
          path: '/api/cards/:card_id/card_custom_field_numbers',
          rawPath: '/api/cards/:id/card_custom_field_numbers',
          method: 'POST',
          name: 'Create a new card custom field number',
          formData: [
              { name: 'custom_field_id', type: 'Integer', isRequired: true },
              { name: 'number', type: 'Float', isRequired: true },
          ]
      },
      {
          // update
          path: '/api/cards/:card_id/card_custom_field_numbers/:card_custom_field_number_id',
          rawPath: '/api/cards/:id/card_custom_field_numbers/:card_custom_field_number_id',
          method: 'PUT',
          name: 'Update a card custom field number',
          formData: [
              { name: 'custom_field_id', type: 'Integer', isRequired: true },
              { name: 'number', type: 'Float', isRequired: true },
          ]
      },
      {
          // destroy
          path: '/api/cards/:card_id/card_custom_field_numbers/:card_custom_field_number_id',
          rawPath: '/api/cards/:id/card_custom_field_numbers/:card_custom_field_number_id',
          method: 'DELETE',
          name: 'Remove a card custom field number'
      },

      // card_custom_field_texts
      {
          // index
          path: '/api/cards/:card_id/card_custom_field_texts',
          rawPath: '/api/cards/:id/card_custom_field_texts',
          method: 'GET',
          name: 'Get a list of card card custom field texts'
      },
      {
          // read
          path: '/api/cards/:card_id/card_custom_field_texts/:card_custom_field_text_id',
          rawPath: '/api/cards/:id/card_custom_field_texts/:card_custom_field_text_id',
          method: 'GET',
          name: 'Get a card custom field text',
      },
      {
          // create
          path: '/api/cards/:card_id/card_custom_field_texts',
          rawPath: '/api/cards/:id/card_custom_field_texts',
          method: 'POST',
          name: 'Create a new card custom field text',
          formData: [
              { name: 'custom_field_id', type: 'Integer', isRequired: true },
              { name: 'text', type: 'String', isRequired: true },
          ]
      },
      {
          // update
          path: '/api/cards/:card_id/card_custom_field_texts/:card_custom_field_text_id',
          rawPath: '/api/cards/:id/card_custom_field_texts/:card_custom_field_text_id',
          method: 'PUT',
          name: 'Update a card custom field text',
          formData: [
              { name: 'custom_field_id', type: 'Integer', isRequired: true },
              { name: 'text', type: 'String', isRequired: true },
          ]
      },
      {
          // destroy
          path: '/api/cards/:card_id/card_custom_field_texts/:card_custom_field_text_id',
          rawPath: '/api/cards/:id/card_custom_field_texts/:card_custom_field_text_id',
          method: 'DELETE',
          name: 'Remove a card custom field text'
      },

      // card_custom_field_single_selections
      {
          // index
          path: '/api/cards/:card_id/card_custom_field_single_selections',
          rawPath: '/api/cards/:id/card_custom_field_single_selections',
          method: 'GET',
          name: 'Get a list of card card custom field single selections'
      },
      {
          // read
          path: '/api/cards/:card_id/card_custom_field_single_selections/:card_custom_field_single_selection_id',
          rawPath: '/api/cards/:id/card_custom_field_single_selections/:card_custom_field_single_selection_id',
          method: 'GET',
          name: 'Get a card custom field single selection',
      },
      {
          // create
          path: '/api/cards/:card_id/card_custom_field_single_selections',
          rawPath: '/api/cards/:id/card_custom_field_single_selections',
          method: 'POST',
          name: 'Create a new card custom field single selection',
          formData: [
              { name: 'custom_field_id', type: 'Integer', isRequired: true },
              { name: 'single_select_option_id', type: 'Integer', isRequired: true },
          ]
      },
      {
          // update
          path: '/api/cards/:card_id/card_custom_field_single_selections/:card_custom_field_single_selection_id',
          rawPath: '/api/cards/:id/card_custom_field_single_selections/:card_custom_field_single_selection_id',
          method: 'PUT',
          name: 'Update a card custom field single selection',
          formData: [
              { name: 'custom_field_id', type: 'Integer', isRequired: true },
              { name: 'single_select_option_id', type: 'Integer', isRequired: true },
          ]
      },
      {
          // destroy
          path: '/api/cards/:card_id/card_custom_field_single_selections/:card_custom_field_single_selection_id',
          rawPath: '/api/cards/:id/card_custom_field_single_selections/:card_custom_field_single_selection_id',
          method: 'DELETE',
          name: 'Remove a card custom field single selection'
      },

      // Card Events
      {
        // index
        path: '/api/cards/:card_id/events',
        rawPath: '/api/cards/:id/events',
        method: 'GET',
        name: 'Get a list of card events',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
      {
        // index
        path: '/api/cards/:card_id/commit_references',
        rawPath: '/api/cards/:id/commit_references',
        method: 'GET',
        name: 'Get a list of commit references',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
      {
        // index
        path: '/api/cards/:card_id/subscriptions',
        rawPath: '/api/cards/:id/subscriptions',
        method: 'GET',
        name: 'Get a list of card subscriptions',
        note: 'Returns either zero or one subscription for the current user. This endpoint does not take any parameters',
        noParams: true,
      },
      {
        // create
        path: '/api/cards/:card_id/subscriptions',
        rawPath: '/api/cards/:id/subscriptions',
        method: 'POST',
        name: 'Create a card subscription',
      },
      {
        // Delete
        path: '/api/cards/:card_id/subscriptions/:subscription_id',
        rawPath: '/api/cards/:card_id/subscriptions/:id',
        method: 'DELETE',
        name: 'Remove a card subscription'
      },
      // Card Tickets
      {
        // index
        path: '/api/cards/:card_id/tickets',
        rawPath: '/api/cards/:id/tickets',
        method: 'GET',
        name: 'Get a list of related tickets'
      },
      // Card Upvoters
      {
        // index
        path: '/api/cards/:card_id/upvoters',
        rawPath: '/api/cards/:id/upvoters',
        method: 'GET',
        name: 'Get a list of upvoters',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
      // Card Upvotes
      {
        // create
        path: '/api/cards/:card_id/upvotes',
        rawPath: '/api/cards/:id/upvotes',
        method: 'POST',
        name: 'Create a card upvote',
        note: 'Creates a card upvote for the current user. This endpoint does not take any data.'
      },
    ]
  },
  {
    title: 'Categories',
    desc: '',
    note: 'Workspace columns are referred to as <code class="inline">categories</code> in the Zube API.',
    endpoints: [
      // Workspace Categories
      {
        // index
        name: 'Get a list of categories',
        path: '/api/workspaces/:workspace_id/categories',
        rawPath: '/api/workspaces/:id/categories',
        method: 'GET',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
      {
        // read
        name: 'Get a category',
        path: '/api/workspaces/:workspace_id/categories/:_categoryId',
        rawPath: '/api/workspaces/:id/categories/:_categoryId',
        method: 'GET',
        note: '<code class="inline">_categoryId</code> is an <code class="inline">ObjectId</code>, not an <code class="inline">integer</code>.'
      },
      {
        // index
        name: 'Get a list of categories metadata',
        path: '/api/workspaces/:workspace_id/categories_metadata',
        rawPath: '/api/workspaces/:id/categories_metadata',
        method: 'GET',
        note: 'Returns a set of categories without their lists of cards. This endpoint does not take any parameters.',
        noParams: true,
      },
      {
        // read
        name: 'Get a category\'s metadata',
        path: '/api/workspaces/:workspace_id/categories_metadata/:_categoryId',
        rawPath: '/api/workspaces/:id/categories_metadata/:_categoryId',
        method: 'GET',
        note: 'Returns a single category without it\'s list of cards. <code class="inline">_categoryId</code> is an <code class="inline">ObjectId</code>, not an <code class="inline">integer</code>.'
      },
    ]
  },
  {
    title: 'Custom Fields',
    desc: '',
    endpoints: [
        // Custom Field
        {
            // index
            path: '/api/projects/:project_id/custom_fields',
            rawPath: '/api/projects/:id/custom_fields',
            method: 'GET',
            name: 'Get a list of custom fields'
        },
        {
            // read
            path: '/api/projects/:project_id/custom_fields/:custom_field_id',
            rawPath: '/api/projects/:id/custom_fields/:custom_field_id',
            method: 'GET',
            name: 'Get a custom field',
        },
        {
            // create
            path: '/api/projects/:project_id/custom_fields',
            rawPath: '/api/projects/:id/custom_fields',
            method: 'POST',
            name: 'Create a new custom field',
            formData: [
                { name: 'data_type', type: 'String', isRequired: true, note: 'Must be one of <code class="inline">date</code>, <code class="inline">number</code>, <code class="inline">text</code>, or <code class="inline">single_select</code>' },
                { name: 'name', type: 'String', isRequired: true },
            ]
        },
        {
            // update
            path: '/api/projects/:project_id/custom_fields/:custom_field_id',
            rawPath: '/api/projects/:id/custom_fields/:custom_field_id',
            method: 'PUT',
            name: 'Update a custom field',
            formData: [
                { name: 'text', type: 'String', isRequired: true },
            ]
        },
        {
            // destroy
            path: '/api/projects/:project_id/custom_fields/:custom_field_id',
            rawPath: '/api/projects/:id/custom_fields/:custom_field_id',
            method: 'DELETE',
            name: 'Remove a custom field'
        },

        // Single Select Options
        {
            // index
            path: '/api/custom_fields/:custom_field_id/single_select_options',
            rawPath: '/api/custom_fields/:id/single_select_options',
            method: 'GET',
            name: 'Get a list of custom field single select options'
        },
        {
            // read
            path: '/api/custom_fields/:custom_field_id/single_select_options/:single_select_option_id',
            rawPath: '/api/custom_fields/:id/single_select_options/:single_select_option_id',
            method: 'GET',
            name: 'Get a custom field single select option',
        },
        {
            // create
            path: '/api/custom_fields/:custom_field_id/single_select_options',
            rawPath: '/api/custom_fields/:id/single_select_options',
            method: 'POST',
            name: 'Create a new custom field single select option',
            formData: [
                { name: 'text', type: 'String', isRequired: true },
            ]
        },
        {
            // update
            path: '/api/custom_fields/:custom_field_id/single_select_options/:single_select_option_id',
            rawPath: '/api/custom_fields/:id/single_select_options/:single_select_option_id',
            method: 'PUT',
            name: 'Update a custom field single select option',
            formData: [
                { name: 'text', type: 'String', isRequired: true },
            ]
        },
        {
            // destroy
            path: '/api/custom_fields/:custom_field_id/single_select_options/:single_select_option_id',
            rawPath: '/api/custom_fields/:id/single_select_options/:single_select_option_id',
            method: 'DELETE',
            name: 'Remove a custom field single select option'
        },
    ]
  },
  {
    title: 'Epics',
    desc: '',
    endpoints: [
      {
        // index
        name: 'Get a list of epics',
        path: '/api/projects/:project_id/epics',
        rawPath: '/api/projects/:id/epics',
        method: 'GET',
        extendedQueryParams: [
            { name: 'where[after_number]', type: 'integer' },
            { name: 'where[created_after]', type: 'timestamp' },
            { name: 'where[updated_after]', type: 'timestamp' },
        ]
      },
      {
        // create
        name: 'Create an epic',
        path: '/api/projects/:project_id/epics',
        rawPath: '/api/projects/:id/epics',
        method: 'POST',
        formData: [
          { name: 'title', type: 'String', isRequired: true },
          { name: 'description', type: 'Text', isRequired: false },
          { name: 'assignee_id', type: 'Integer', isRequired: false },
          { name: 'epic_list_id', type: 'Boolean', isRequired: false },
          { name: 'label_ids', type: 'Array', isRequired: false, note: 'Array of <code class="inline">label.id</code>s' },
          { name: 'due_on', type: 'Timestamp', isRequired: false },
          { name: 'track_cards', type: 'Boolean', isRequired: false },
          { name: 'color', type: 'String', isRequired: false, note: 'Hex color code string without preceding "#"' },
          { name: 'after_target_id', type: 'Integer', note: '<code class="inline">after_target_id</code> is the <code class="inline">id</code> of the epic after which this epic should be placed' },
          { name: 'before_target_id', type: 'Integer', note: '<code class="inline">before_target_id</code> is the <code class="inline">id</code> of the epic before which this epic should be placed' },
          { name: 'target_position', type: 'Integer', note: 'Refers to the target index position of the epic' },
        ]
      },
      {
        // read
        name: 'Get an epic',
        path: '/api/projects/:project_id/epics/:epic_id',
        rawPath: '/api/projects/:id/epics/:epic_id',
        method: 'GET'
      },
      {
        // update
        name: 'Update an epic',
        path: '/api/projects/:project_id/epics/:epic_id',
        rawPath: '/api/projects/:id/epics/:epic_id',
        method: 'PUT',
        formData: [
            { name: 'assignee_id', type: 'Integer', isRequired: true },
            { name: 'color', type: 'String', isRequired: true, note: 'Hex color code string without preceding "#"' },
            { name: 'description', type: 'Text', isRequired: true },
            { name: 'due_on', type: 'Timestamp', isRequired: true },
            { name: 'epic_list_id', type: 'Boolean', isRequired: true },
            { name: 'label_ids', type: 'Array', isRequired: true, note: 'Array of <code class="inline">label.id</code>s' },
            { name: 'state', type: 'String', isRequired: true, note: 'Only accepts <code class="inline">open</code> or <code class="inline">closed</code>' },
            { name: 'status', type: 'String', isRequired: true, note: 'Must be one of <code class="inline">new</code>, <code class="inline">queued</code>, <code class="inline">in_progress</code>, <code class="inline">completed</code>, <code class="inline">closed</code>, or <code class="inline">archived</code>' },
            { name: 'title', type: 'String', isRequired: true },
            { name: 'track_cards', type: 'Boolean', isRequired: true },
        ]
      },
      {
          // Move
          name: 'Move an epic',
          path: '/api/projects/:project_id/epics/:epic_id/move',
          rawPath: '/api/projects/:id/epics/:epic_id/move',
          method: 'PUT',
          formData: [
              { name: 'assignee_id', type: 'Integer', isRequired: true },
              { name: 'color', type: 'String', isRequired: true, note: 'Hex color code string without preceding "#"' },
              { name: 'description', type: 'Text', isRequired: true },
              { name: 'due_on', type: 'Timestamp', isRequired: true },
              { name: 'epic_list_id', type: 'Boolean', isRequired: true },
              { name: 'label_ids', type: 'Array', isRequired: true, note: 'Array of <code class="inline">label.id</code>s' },
              { name: 'state', type: 'String', isRequired: true, note: 'Only accepts <code class="inline">open</code> or <code class="inline">closed</code>' },
              { name: 'status', type: 'String', isRequired: true, note: 'Must be one of <code class="inline">new</code>, <code class="inline">queued</code>, <code class="inline">in_progress</code>, <code class="inline">completed</code>, <code class="inline">closed</code>, or <code class="inline">archived</code>' },
              { name: 'title', type: 'String', isRequired: true },
              { name: 'track_cards', type: 'Boolean', isRequired: true },
              { name: 'after_target_id', type: 'Integer', note: '<code class="inline">after_target_id</code> is the <code class="inline">id</code> of the epic after which this epic should be placed' },
              { name: 'before_target_id', type: 'Integer', note: '<code class="inline">before_target_id</code> is the <code class="inline">id</code> of the epic before which this epic should be placed' },
              { name: 'target_position', type: 'Integer', note: 'Refers to the target index position of the epic' },
          ],
          note: 'Provide only one of <code class="inline">target_position</code>, <code class="inline">after_target_id</code> or <code class="inline">before_target_id</code>.'
      },
      // Epic Cards
      {
        // index
        name: 'Get a list of epic cards',
        path: '/api/epics/:epic_id/cards',
        rawPath: '/api/epics/:id/cards',
        method: 'GET'
      },
      {
        // create
        name: 'Add a card to an epic',
        path: '/api/epics/:epic_id/cards',
        rawPath: '/api/epics/:id/cards',
        method: 'POST',
        formData: [
          { name: 'card_id', type: 'Integer', isRequired: true },
        ]
      },
      {
        // destroy
        name: 'Remove a card from an epic',
        path: '/api/epics/:epic_id/cards/:card_id',
        rawPath: '/api/epics/:id/cards/:card_id',
        method: 'DELETE'
      },
      // Epic Comments
      {
        // index
        name: 'Get a list of epic comments',
        path: '/api/epics/:epic_id/comments',
        rawPath: '/api/epics/:id/comments',
        method: 'GET'
      },
      {
        // create
        name: 'Create an epic comment',
        path: '/api/epics/:epic_id/comments',
        rawPath: '/api/epics/:id/comments',
        method: 'POST',
        formData: [
          { name: 'body', type: 'Text', isRequired: true },
        ]
      },
      {
        // update
        name: 'Update an epic comment',
        path: '/api/epics/:epic_id/comments/:comment_id',
        rawPath: '/api/epics/:id/comments/:comment_id',
        method: 'PUT',
        formData: [
          { name: 'body', type: 'Text', isRequired: true },
        ]
      },
      {
        // destroy
        name: 'Remove an epic comment',
        path: '/api/epics/:epic_id/comments/:comment_id',
        rawPath: '/api/epics/:id/comments/:comment_id',
        method: 'DELETE'
      },
      // Epic Events
      {
        // index
        name: 'Get a list of epic events',
        path: '/api/epics/:epic_id/events',
        rawPath: '/api/epics/:id/events',
        method: 'GET'
      },
      // Epic Subscriptions
      {
        // index
        name: 'Get a list of epic subscriptions',
        path: '/api/epics/:epic_id/subscriptions',
        rawPath: '/api/epics/:id/subscriptions',
        method: 'GET',
        note: 'Returns either zero or one subscription for the current user. This endpoint does not take any parameters.',
        noParams: true,
      },
      {
        // create
        name: 'Create an epic subscription',
        path: '/api/epics/:epic_id/subscriptions',
        rawPath: '/api/epics/:id/subscriptions',
        method: 'POST'
      },
      {
        // destroy
        name: 'Remove an epic subscription',
        path: '/api/epics/:epic_id/subscriptions/:subscription_id',
        rawPath: '/api/epics/:epic_id/subscriptions/:id',
        method: 'DELETE'
      },
    ]
  },
  {
    title: 'Epic Lists',
    desc: '',
    endpoints: [
      // Epic Lists
      {
        // index
        name: 'Get a list of epic lists',
        path: '/api/projects/:project_id/epic_lists',
        rawPath: '/api/projects/:id/epic_lists',
        method: 'GET',
      },
      {
          // create
          name: 'Create an epic list',
          path: '/api/projects/:project_id/epic_lists',
          rawPath: '/api/projects/:id/epic_lists',
          method: 'POST',
          formData: [
              { name: 'name', type: 'String', isRequired: true },
              { name: 'after_target_id', type: 'Integer', note: '<code class="inline">after_target_id</code> is the <code class="inline">id</code> of the epic list after which this epic list should be placed' },
              { name: 'before_target_id', type: 'Integer', note: '<code class="inline">before_target_id</code> is the <code class="inline">id</code> of the epic list before which this epic list should be placed' },
              { name: 'target_position', type: 'Integer', note: 'Refers to the target index position of the list.' },
          ],
          note: 'Provide only one of <code class="inline">target_position</code>, <code class="inline">after_target_id</code> or <code class="inline">before_target_id</code>.'
      },
      {
          // read
          name: 'Get an epic list',
          path: '/api/projects/:project_id/epic_lists/:epic_list_id',
          rawPath: '/api/projects/:id/epic_lists/:epic_list_id',
          method: 'GET',
      },
      {
          // update
          name: 'Update an epic list',
          path: '/api/projects/:project_id/epic_lists/:epic_list_id',
          rawPath: '/api/projects/:id/epic_lists/:epic_list_id',
          method: 'PUT',
          formData: [
              { name: 'name', type: 'String', isRequired: true },
          ]
      },
      {
          // Move
          name: 'Move an epic list',
          path: '/api/projects/:project_id/epic_lists/:epic_list_id/move',
          rawPath: '/api/projects/:id/epic_lists/:epic_list_id/move',
          method: 'PUT',
          formData: [
              { name: 'after_target_id', type: 'Integer', note: '<code class="inline">after_target_id</code> is the <code class="inline">id</code> of the epic list after which this epic list should be placed' },
              { name: 'before_target_id', type: 'Integer', note: '<code class="inline">before_target_id</code> is the <code class="inline">id</code> of the epic list before which this epic list should be placed' },
              { name: 'target_position', type: 'Integer', note: 'Refers to the target index position of the list.' },
          ],
          note: 'Provide only one of <code class="inline">target_position</code>, <code class="inline">after_target_id</code> or <code class="inline">before_target_id</code>.'
      },
      {
          // destroy
          name: 'Delete an epic list',
          path: '/api/projects/:project_id/epic_lists/:epic_list_id',
          rawPath: '/api/projects/:id/epic_lists/:epic_list_id',
          method: 'DELETE'
      }
    ]
  },
  {
    title: 'Labels',
    desc: '',
    endpoints: [
      // Labels
      {
        // index
        name: 'Get a list of labels',
        path: '/api/projects/:project_id/labels',
        rawPath: '/api/projects/:id/labels',
        method: 'GET'
      },
      {
        // create
        name: 'Create a label',
        path: '/api/projects/:project_id/labels',
        rawPath: '/api/projects/:id/labels',
        method: 'POST',
        formData: [
          { name: 'name', type: 'String', isRequired: true },
          { name: 'color', type: 'String', isRequired: true, note: 'Hex color code string without preceding "#"' },
        ]
      },
      {
        // read
        name: 'Get a label',
        path: '/api/projects/:project_id/labels/:label_id',
        rawPath: '/api/projects/:id/labels/:label_id',
        method: 'GET'
      },
      {
        // update
        name: 'Update a label',
        path: '/api/projects/:project_id/labels/:label_id',
        rawPath: '/api/projects/:id/labels/:label_id',
        method: 'PUT',
        formData: [
          { name: 'name', type: 'String', isRequired: true },
          { name: 'color', type: 'String', isRequired: true, note: 'Hex color code string without preceding "#"' },
        ]
      },
      {
        // destroy
        name: 'Delete a label',
        path: '/api/projects/:project_id/labels/:label_id',
        rawPath: '/api/projects/:id/labels/:label_id',
        method: 'DELETE'
      },
    ]
  },
  {
    title: 'Notifications',
    desc: '',
    endpoints: [
      {
        // index
        name: 'Get a list of notifications',
        path: '/api/notifications',
        rawPath: '/api/notifications',
        method: 'GET',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
      {
        // update
        name: 'Update a notification',
        path: '/api/notifications/:_notificationId',
        rawPath: '/api/notifications/:_id',
        method: 'PUT',
        formData: [
          { name: 'read', type: 'Boolean', isRequired: true },
        ],
        note: '<code class="inline">_notificationId</code> is an <code class="inline">ObjectId</code>, not an <code class="inline">integer</code>.'
      },
      {
        // destroy
        name: 'Delete a notification',
        path: '/api/notifications/:_notificationId',
        rawPath: '/api/notifications/:_id',
        method: 'DELETE',
        note: '<code class="inline">_notificationId</code> is an <code class="inline">ObjectId</code>, not an <code class="inline">integer</code>.'
      },
    ]
  },
  {
    title: 'Projects',
    desc: '',
    endpoints: [
      {
        // index
        name: 'Get a list of projects',
        path: '/api/projects',
        rawPath: '/api/projects',
        method: 'GET'
      },
      {
        // create
        name: 'Create a project',
        path: '/api/projects',
        rawPath: '/api/projects',
        method: 'POST',
        formData: [
          { name: 'account_id', type: 'Integer', isRequired: true },
          { name: 'name', type: 'String', isRequired: true },
          { name: 'description', type: 'String', isRequired: false },
        ]
      },
      {
        // read
        name: 'Get a project',
        path: '/api/projects/:project_id',
        rawPath: '/api/projects/:id',
        method: 'GET'
      },
      {
        // update
        name: 'Update a project',
        path: '/api/projects/:project_id',
        rawPath: '/api/projects/:id',
        method: 'PUT',
        formData: [
          { name: 'name', type: 'String', isRequired: true },
          { name: 'description', type: 'String', isRequired: false },
          { name: 'color', type: 'String', isRequired: false, note: 'Hex color code string without preceding "#"' },
          { name: 'triage', type: 'Boolean', isRequired: false, note: 'Only valid for projects with one workspace' },
          { name: 'auto_add_github_users', type: 'Boolean', isRequired: false },
          { name: 'should_use_fibonacci_scale', type: 'Boolean', isRequired: false },
        ]
      },
      {
        // destroy
        name: 'Delete a project',
        path: '/api/projects/:project_id',
        rawPath: '/api/projects/:id',
        method: 'DELETE'
      },
      // Project Admin Members
      {
        // index
        name: 'Get a list of project admins',
        path: '/api/projects/:project_id/admin_members',
        rawPath: '/api/projects/:id/admin_members',
        method: 'GET'
      },
      {
        // create
        name: 'Add a project admin',
        path: '/api/projects/:project_id/admin_members/:person_id',
        rawPath: '/api/projects/:id/admin_members',
        method: 'POST',
        formData: [
          { name: 'person_id', type: 'Integer', isRequired: true },
        ]
      },
      {
        // destroy
        name: 'Remove a project admin',
        path: '/api/projects/:project_id/admin_members/:person_id',
        rawPath: '/api/projects/:id/admin_members/:person_id',
        method: 'DELETE'
      },
      // Project Members
      {
        // index
        name: 'Get a list of project members',
        path: '/api/projects/:project_id/members',
        rawPath: '/api/projects/:id/members',
        method: 'GET'
      },
      {
        // create
        name: 'Add a project member',
        path: '/api/projects/:project_id/members',
        rawPath: '/api/projects/:id/members',
        method: 'POST',
        formData: [
          { name: 'person_id', type: 'Integer', isRequired: true },
        ]
      },
      {
        // destroy
        name: 'Remove a project member',
        path: '/api/projects/:project_id/members/:person_id',
        rawPath: '/api/projects/:id/members/:person_id',
        method: 'DELETE'
      },
      // Project Collaborators
      {
        name: 'Get a list of project collaborators',
        path: '/api/projects/:project_id/collaborators',
        rawPath: '/api/projects/:id/collaborators',
        method: 'GET',
      },
      // Project Cards
      {
        // index
        name: 'Get a list of project cards',
        path: '/api/projects/:project_id/cards',
        rawPath: '/api/projects/:id/cards',
        method: 'GET',
        extendedQueryParams: [
            { name: 'where[after_number]', type: 'integer' },
            { name: 'where[assignee_ids][]', type: 'Array', isRequired: false, note: 'Array of <code class="inline">assignee.id</code>s or <code class="inline">null</code>' },
            { name: 'where[created_after]', type: 'timestamp' },
            { name: 'where[labels][]', type: 'Array', isRequired: false, note: 'Array of <code class="inline">label.name</code>s or <code class="inline">null</code>' },
            { name: 'where[milestones][]', type: 'Array', isRequired: false, note: 'Array of <code class="inline">milestone.title</code>s or <code class="inline">null</code>' },
            { name: 'where[source_ids][]', type: 'Array', isRequired: false, note: 'Array of <code class="inline">source.id</code>s or <code class="inline">null</code>' },
            { name: 'where[types]', type: 'String', isRequired: false, note: 'Only accepts <code class="inline">issue</code>, <code class="inline">pull_request</code> or <code class="inline">null</code>' },
            { name: 'where[updated_after]', type: 'timestamp' },
            { name: 'order[by]', type: 'String', isRequired: true, note: 'Accepts <code class="inline">assignee</code>, <code class="inline">creator</code>, <code class="inline">milestone</code> or <code class="inline">sprint</code>' },
            { name: 'order[direction]', type: 'String', isRequired: true, note: 'Only accepts <code class="inline">asc</code> or <code class="inline">desc</code>' },
        ]
      },
      {
        // triage
        name: 'Get a list of cards in triage',
        path: '/api/projects/:project_id/triage_cards',
        rawPath: '/api/projects/:id/triage_cards',
        method: 'GET',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
      // Milestones
      {
        // index
        name: 'Get a list of milestones',
        path: '/api/projects/:project_id/milestones',
        rawPath: '/api/projects/:id/milestones',
        method: 'GET'
      },
      // Customers
      {
        // index
        name: 'Get a list of customers',
        path: '/api/projects/:project_id/customers',
        rawPath: '/api/projects/:id/customers',
        method: 'GET'
      },
      {
        // create
        name: 'Add a customer',
        path: '/api/projects/:project_id/customers',
        rawPath: '/api/projects/:id/customers',
        method: 'POST',
        formData: [
          { name: 'name', type: 'String', isRequired: true },
          { name: 'contact', type: 'String', },
        ]
      },
      {
        // read
        name: 'Get a customer',
        path: '/api/projects/:project_id/customers/:customer_id',
        rawPath: '/api/projects/:id/customers/:customer_id',
        method: 'GET'
      },
      {
        // update
        name: 'Update a customer',
        path: '/api/projects/:project_id/customers/:customer_id',
        rawPath: '/api/projects/:id/customers/:customer_id',
        method: 'PUT',
        formData: [
          { name: 'name', type: 'String', isRequired: true },
          { name: 'contact', type: 'String', },
        ]
      },
      {
        // destroy
        name: 'Remove a customer',
        path: '/api/projects/:project_id/customers/:customer_id',
        rawPath: '/api/projects/:id/customers/:customer_id',
        method: 'DELETE'
      },
      // User notification settings
      {
        name: 'Get your triage subscription level settings',
        path: '/api/projects/:project_id/triage_user_settings',
        rawPath: '/api/projects/:id/triage_user_settings',
        method: 'GET',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
      {
        name: 'Get your triage subscription level settings',
        path: '/api/projects/:project_id/triage_user_settings/:user_triage_setting_id',
        rawPath: '/api/projects/:id/triage_user_settings/:user_triage_setting_id',
        method: 'GET',
      },
      {
        name: 'Update your triage subscription level settings',
        path: '/api/projects/:project_id/triage_user_settings/:user_triage_setting_id',
        rawPath: '/api/projects/:id/triage_user_settings/:user_triage_setting_id',
        method: 'PUT',
        formData: [
          { name: 'subscription_level', type: 'String', isRequired: true, note: 'Must be one of <code class="inline">following</code>, <code class="inline">not_following</code>, or <code class="inline">muted</code>' },
        ],
        note: 'This endpoint allows you to edit how Zube automatically subscribes you to cards in Triage.'
      },
      {
        name: 'Get your project subscription level settings',
        path: '/api/projects/:project_id/user_settings',
        rawPath: '/api/projects/:id/user_settings',
        method: 'GET',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
      {
        name: 'Get your project subscription level settings by id',
        path: '/api/projects/:project_id/user_settings/:user_project_setting_id',
        rawPath: '/api/projects/:id/user_settings/:user_project_setting_id',
        method: 'GET'
      },
      {
        name: 'Update your project subscription level settings',
        path: '/api/projects/:project_id/user_settings/:user_project_setting_id',
        rawPath: '/api/projects/:id/user_settings/:user_project_setting_id',
        method: 'PUT',
        formData: [
          { name: 'subscription_level', type: 'String', isRequired: true, note: 'Must be one of <code class="inline">following</code>, <code class="inline">not_following</code>, or <code class="inline">muted</code>' },
        ],
        note: 'This endpoint allows you to edit how Zube automatically subscribes you to Epics and Tickets.'
      },
      // User Email Prefs
      {
        name: 'Get your project email preferences',
        path: '/api/projects/:project_id/user_email_preferences',
        rawPath: '/api/projects/:id/user_email_preferences',
        method: 'GET',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
      {
        name: 'Get your project email preferences by id',
        path: '/api/projects/:project_id/user_email_preferences/:user_project_email_preference_id',
        rawPath: '/api/projects/:id/user_email_preferences/:user_project_email_preference_id',
        method: 'GET',
      },
      {
        name: 'Update your project email preferences',
        path: '/api/projects/:project_id/user_email_preferences/:user_project_email_preference_id',
        rawPath: '/api/projects/:id/user_email_preferences/:user_project_email_preference_id',
        method: 'PUT',
        formData: [
          { name: 'email', type: 'String', isRequired: true },
          { name: 'card_added_to_triage', type: 'Boolean', isRequired: true },
          { name: 'card_assigned_to_self', type: 'Boolean', isRequired: true },
          { name: 'card_assignee_added', type: 'Boolean', isRequired: true },
          { name: 'card_card_linked', type: 'Boolean', isRequired: true },
          { name: 'card_comment_added', type: 'Boolean', isRequired: true },
          { name: 'card_comment_mention', type: 'Boolean', isRequired: true },
          { name: 'card_epic_added', type: 'Boolean', isRequired: true },
          { name: 'card_label_added', type: 'Boolean', isRequired: true },
          { name: 'card_mention', type: 'Boolean', isRequired: true },
          { name: 'card_milestone_added', type: 'Boolean', isRequired: true },
          { name: 'card_points_changed', type: 'Boolean', isRequired: true },
          { name: 'card_priority_changed', type: 'Boolean', isRequired: true },
          { name: 'card_ticket_added', type: 'Boolean', isRequired: true },
          { name: 'epic_assigned_to_self', type: 'Boolean', isRequired: true },
          { name: 'epic_assignee_added', type: 'Boolean', isRequired: true },
          { name: 'epic_card_added', type: 'Boolean', isRequired: true },
          { name: 'epic_comment_added', type: 'Boolean', isRequired: true },
          { name: 'epic_comment_mention', type: 'Boolean', isRequired: true },
          { name: 'epic_created', type: 'Boolean', isRequired: true },
          { name: 'epic_due_date_changed', type: 'Boolean', isRequired: true },
          { name: 'epic_mention', type: 'Boolean', isRequired: true },
          { name: 'epic_status_closed', type: 'Boolean', isRequired: true },
          { name: 'epic_status_completed', type: 'Boolean', isRequired: true },
          { name: 'epic_status_in_progress', type: 'Boolean', isRequired: true },
          { name: 'epic_status_queued', type: 'Boolean', isRequired: true },
          { name: 'pr_added_to_triage', type: 'Boolean', isRequired: true },
          { name: 'pr_assigned_to_self', type: 'Boolean', isRequired: true },
          { name: 'pr_assignee_added', type: 'Boolean', isRequired: true },
          { name: 'pr_card_linked', type: 'Boolean', isRequired: true },
          { name: 'pr_comment_added', type: 'Boolean', isRequired: true },
          { name: 'pr_comment_mention', type: 'Boolean', isRequired: true },
          { name: 'pr_epic_added', type: 'Boolean', isRequired: true },
          { name: 'pr_label_added', type: 'Boolean', isRequired: true },
          { name: 'pr_mention', type: 'Boolean', isRequired: true },
          { name: 'pr_milestone_added', type: 'Boolean', isRequired: true },
          { name: 'pr_points_changed', type: 'Boolean', isRequired: true },
          { name: 'pr_priority_changed', type: 'Boolean', isRequired: true },
          { name: 'pr_ticket_added', type: 'Boolean', isRequired: true },
          { name: 'ticket_assigned_to_self', type: 'Boolean', isRequired: true },
          { name: 'ticket_assignee_added', type: 'Boolean', isRequired: true },
          { name: 'ticket_card_added', type: 'Boolean', isRequired: true },
          { name: 'ticket_comment_added', type: 'Boolean', isRequired: true },
          { name: 'ticket_comment_mention', type: 'Boolean', isRequired: true },
          { name: 'ticket_created', type: 'Boolean', isRequired: true },
          { name: 'ticket_due_date_changed', type: 'Boolean', isRequired: true },
          { name: 'ticket_label_added', type: 'Boolean', isRequired: true },
          { name: 'ticket_mention', type: 'Boolean', isRequired: true },
          { name: 'ticket_priority_changed', type: 'Boolean', isRequired: true },
          { name: 'ticket_start_date_changed', type: 'Boolean', isRequired: true },
          { name: 'ticket_status_closed', type: 'Boolean', isRequired: true },
          { name: 'ticket_status_completed', type: 'Boolean', isRequired: true },
          { name: 'ticket_status_in_progress', type: 'Boolean', isRequired: true },
          { name: 'ticket_status_queued', type: 'Boolean', isRequired: true },
        ]
      },
      // User In App Prefs
      {
        name: 'Get your project in app preferences',
        path: '/api/projects/:project_id/user_in_app_preferences',
        rawPath: '/api/projects/:id/user_in_app_preferences',
        method: 'GET',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
      {
        name: 'Get your project in app preferences by id',
        path: '/api/projects/:project_id/user_in_app_preferences/:user_project_in_app_preference_id',
        rawPath: '/api/projects/:id/user_in_app_preferences/:user_project_in_app_preference_id',
        method: 'GET',
      },
      {
        name: 'Update your project in app preferences',
        path: '/api/projects/:project_id/user_in_app_preferences/:user_project_in_app_preference_id',
        rawPath: '/api/projects/:id/user_in_app_preferences/:user_project_in_app_preference_id',
        method: 'PUT',
        formData: [
          { name: 'card_added_to_triage', type: 'Boolean', isRequired: true },
          { name: 'card_assigned_to_self', type: 'Boolean', isRequired: true },
          { name: 'card_assignee_added', type: 'Boolean', isRequired: true },
          { name: 'card_card_linked', type: 'Boolean', isRequired: true },
          { name: 'card_comment_added', type: 'Boolean', isRequired: true },
          { name: 'card_comment_mention', type: 'Boolean', isRequired: true },
          { name: 'card_epic_added', type: 'Boolean', isRequired: true },
          { name: 'card_label_added', type: 'Boolean', isRequired: true },
          { name: 'card_mention', type: 'Boolean', isRequired: true },
          { name: 'card_milestone_added', type: 'Boolean', isRequired: true },
          { name: 'card_points_changed', type: 'Boolean', isRequired: true },
          { name: 'card_priority_changed', type: 'Boolean', isRequired: true },
          { name: 'card_ticket_added', type: 'Boolean', isRequired: true },
          { name: 'epic_assigned_to_self', type: 'Boolean', isRequired: true },
          { name: 'epic_assignee_added', type: 'Boolean', isRequired: true },
          { name: 'epic_card_added', type: 'Boolean', isRequired: true },
          { name: 'epic_comment_added', type: 'Boolean', isRequired: true },
          { name: 'epic_comment_mention', type: 'Boolean', isRequired: true },
          { name: 'epic_created', type: 'Boolean', isRequired: true },
          { name: 'epic_due_date_changed', type: 'Boolean', isRequired: true },
          { name: 'epic_mention', type: 'Boolean', isRequired: true },
          { name: 'epic_status_closed', type: 'Boolean', isRequired: true },
          { name: 'epic_status_completed', type: 'Boolean', isRequired: true },
          { name: 'epic_status_in_progress', type: 'Boolean', isRequired: true },
          { name: 'epic_status_queued', type: 'Boolean', isRequired: true },
          { name: 'pr_added_to_triage', type: 'Boolean', isRequired: true },
          { name: 'pr_assigned_to_self', type: 'Boolean', isRequired: true },
          { name: 'pr_assignee_added', type: 'Boolean', isRequired: true },
          { name: 'pr_card_linked', type: 'Boolean', isRequired: true },
          { name: 'pr_comment_added', type: 'Boolean', isRequired: true },
          { name: 'pr_comment_mention', type: 'Boolean', isRequired: true },
          { name: 'pr_epic_added', type: 'Boolean', isRequired: true },
          { name: 'pr_label_added', type: 'Boolean', isRequired: true },
          { name: 'pr_mention', type: 'Boolean', isRequired: true },
          { name: 'pr_milestone_added', type: 'Boolean', isRequired: true },
          { name: 'pr_points_changed', type: 'Boolean', isRequired: true },
          { name: 'pr_priority_changed', type: 'Boolean', isRequired: true },
          { name: 'pr_ticket_added', type: 'Boolean', isRequired: true },
          { name: 'ticket_assigned_to_self', type: 'Boolean', isRequired: true },
          { name: 'ticket_assignee_added', type: 'Boolean', isRequired: true },
          { name: 'ticket_card_added', type: 'Boolean', isRequired: true },
          { name: 'ticket_comment_added', type: 'Boolean', isRequired: true },
          { name: 'ticket_comment_mention', type: 'Boolean', isRequired: true },
          { name: 'ticket_created', type: 'Boolean', isRequired: true },
          { name: 'ticket_due_date_changed', type: 'Boolean', isRequired: true },
          { name: 'ticket_label_added', type: 'Boolean', isRequired: true },
          { name: 'ticket_mention', type: 'Boolean', isRequired: true },
          { name: 'ticket_priority_changed', type: 'Boolean', isRequired: true },
          { name: 'ticket_start_date_changed', type: 'Boolean', isRequired: true },
          { name: 'ticket_status_closed', type: 'Boolean', isRequired: true },
          { name: 'ticket_status_completed', type: 'Boolean', isRequired: true },
          { name: 'ticket_status_in_progress', type: 'Boolean', isRequired: true },
          { name: 'ticket_status_queued', type: 'Boolean', isRequired: true },
        ]
      },
    ]
  },
  {
    title: 'Sprints',
    desc: '',
    endpoints: [
      {
        // index
        name: 'Get a list of sprints',
        path: '/api/workspaces/:workspace_id/sprints',
        rawPath: '/api/workspaces/:id/sprints',
        method: 'GET'
      },
      {
        // create
        name: 'Create a sprint',
        path: '/api/workspaces/:workspace_id/sprints',
        rawPath: '/api/workspaces/:id/sprints',
        method: 'POST',
        formData: [
          { name: 'title', type: 'String', isRequired: true },
          { name: 'start_date', type: 'Timestamp', isRequired: true },
          { name: 'end_date', type: 'Timestamp', isRequired: true },
          { name: 'description', type: 'Text', isRequired: false },
        ]
      },
      {
        // read
        name: 'Get a sprint',
        path: '/api/workspaces/:workspace_id/sprints/:sprint_id',
        rawPath: '/api/workspaces/:id/sprints/:sprint_id',
        method: 'GET'
      },
      {
        // update
        name: 'Update a sprint',
        path: '/api/workspaces/:workspace_id/sprints/:sprint_id',
        rawPath: '/api/workspaces/:id/sprints/:sprint_id',
        method: 'PUT',
        formData: [
          { name: 'title', type: 'String', isRequired: true },
          { name: 'start_date', type: 'Timestamp', isRequired: true },
          { name: 'end_date', type: 'Timestamp', isRequired: true },
          { name: 'description', type: 'Text', isRequired: true },
          { name: 'state', type: 'String', isRequired: true, note: 'Only accepts <code class="inline">open</code> or <code class="inline">closed</code>' },
        ]
      },
      {
        // destroy
        name: 'Delete a sprint',
        path: '/api/workspaces/:workspace_id/sprints/:sprint_id',
        rawPath: '/api/workspaces/:id/sprints/:sprint_id',
        method: 'DELETE'
      },
      {
        // index
        name: 'Get a list of events',
        path: '/api/sprints/:sprint_id/events',
        rawPath: '/api/sprints/:id/events',
        method: 'GET',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
    ]
  },
  {
    title: 'Sources',
    desc: '',
    endpoints: [
      {
        // index
        name: 'Get a list of sources',
        path: '/api/sources',
        rawPath: '/api/sources',
        method: 'GET'
      },
      {
        // destroy
        name: 'Remove a source',
        path: '/api/sources/:source_id',
        rawPath: '/api/sources/:id',
        method: 'DELETE'
      },
      // Source Collaborators
      {
        // index
        name: 'Get a list of source collaborators',
        path: '/api/sources/:source_id/collaborators',
        rawPath: '/api/sources/:id/collaborators',
        method: 'GET'
      },
      // Source Milestones
      {
        // index
        name: 'Get a list of milestones',
        path: '/api/sources/:source_id/milestones',
        rawPath: '/api/sources/:id/milestones',
        method: 'GET'
      },
      {
        // create
        name: 'Create a milestone',
        path: '/api/sources/:source_id/milestones',
        rawPath: '/api/sources/:id/milestones',
        method: 'POST',
        formData: [
          { name: 'title', type: 'String', isRequired: true },
          { name: 'description', type: 'Text', isRequired: false },
          { name: 'due_on', type: 'Timestamp', isRequired: false },
        ]
      },
      {
        // read
        name: 'Get a milestone',
        path: '/api/sources/:source_id/milestones/:milestone_id',
        rawPath: '/api/sources/:id/milestones/:milestone_id',
        method: 'GET'
      },
      {
        // update
        name: 'Update a milestone',
        path: '/api/sources/:source_id/milestones/:milestone_id',
        rawPath: '/api/sources/:id/milestones/:milestone_id',
        method: 'PUT',
        formData: [
          { name: 'title', type: 'String', isRequired: true },
          { name: 'description', type: 'Text', isRequired: true },
          { name: 'due_on', type: 'Timestamp', isRequired: true },
          { name: 'state', type: 'String', isRequired: true, note: 'Only accepts <code class="inline">open</code> or <code class="inline">closed</code>' },
        ]
      },
      {
        // destroy
        name: 'Delete a milestone',
        path: '/api/sources/:source_id/milestones/:milestone_id',
        rawPath: '/api/sources/:id/milestones/:milestone_id',
        method: 'DELETE'
      },
    ]
  },
  {
    title: 'Tickets',
    desc: '',
    endpoints: [
      // Tickets
      {
        // index
        name: 'Get a list of tickets',
        path: '/api/projects/:project_id/tickets',
        rawPath: '/api/projects/:id/tickets',
        method: 'GET',
        extendedQueryParams: [
            { name: 'where[after_number]', type: 'integer' },
            { name: 'where[created_after]', type: 'timestamp' },
            { name: 'where[updated_after]', type: 'timestamp' },
        ]
      },
      {
        // create
        name: 'Create a ticket',
        path: '/api/projects/:project_id/tickets',
        rawPath: '/api/projects/:id/tickets',
        method: 'POST',
        formData: [
          { name: 'title', type: 'String', isRequired: true },
          { name: 'description', type: 'Text', isRequired: false },
          { name: 'type', type: 'String', isRequired: false, note: 'Must be one of <code class="inline">task</code>, <code class="inline">bug</code>, <code class="inline">feature</code>, <code class="inline">question</code>' },
          { name: 'priority', type: 'Number', isRequired: false, note: 'Must be one of <code class="inline">1</code>, <code class="inline">2</code>, <code class="inline">3</code>, <code class="inline">4</code>' },
          { name: 'due_on', type: 'Timestamp', isRequired: false },
          { name: 'start_date', type: 'Timestamp', isRequired: false },
          { name: 'track_cards', type: 'Boolean', isRequired: false },
          { name: 'customer_id', type: 'Integer', isRequired: false },
          { name: 'assignee_id', type: 'Integer', isRequired: false },
        ]
      },
      {
        // read
        name: 'Get a ticket',
        path: '/api/projects/:project_id/tickets/:ticket_id',
        rawPath: '/api/projects/:id/tickets/:ticket_id',
        method: 'GET'
      },
      {
        // update
        name: 'Update a ticket',
        path: '/api/projects/:project_id/tickets/:ticket_id',
        rawPath: '/api/projects/:id/tickets/:ticket_id',
        method: 'PUT',
        formData: [
          { name: 'title', type: 'String', isRequired: true },
          { name: 'description', type: 'Text', isRequired: true },
          { name: 'type', type: 'String', isRequired: true, note: 'Must be one of <code class="inline">task</code>, <code class="inline">bug</code>, <code class="inline">feature</code>, or <code class="inline">question</code>' },
          { name: 'priority', type: 'Number', isRequired: true, note: 'Must be one of <code class="inline">1</code>, <code class="inline">2</code>, <code class="inline">3</code>, <code class="inline">4</code>' },
          { name: 'due_on', type: 'Timestamp', isRequired: true },
          { name: 'start_date', type: 'Timestamp', isRequired: true },
          { name: 'track_cards', type: 'Boolean', isRequired: true },
          { name: 'assignee_id', type: 'Integer', isRequired: true },
          { name: 'customer_id', type: 'Integer', isRequired: true },
          { name: 'state', type: 'String', isRequired: true, note: 'Only accepts <code class="inline">open</code> or <code class="inline">closed</code>' },
          { name: 'status', type: 'String', isRequired: true, note: 'Must be one of <code class="inline">new</code>, <code class="inline">queued</code>, <code class="inline">in_progress</code>, <code class="inline">completed</code>, <code class="inline">closed</code>, or <code class="inline">archived</code>' },
        ]
      },
      // Ticket Cards
      {
        // index
        name: 'Get a list of cards',
        path: '/api/tickets/:ticket_id/cards',
        rawPath: '/api/tickets/:id/cards',
        method: 'GET'
      },
      {
        // create
        name: 'Add a card to a ticket',
        path: '/api/tickets/:ticket_id/cards',
        rawPath: '/api/tickets/:id/cards',
        method: 'POST',
        formData: [
          { name: 'card_id', type: 'Integer', isRequired: true },
        ]
      },
      {
        // destroy
        name: 'Remove a card from a ticket',
        path: '/api/tickets/:ticket_id/cards/:card_id',
        rawPath: '/api/tickets/:id/cards/:card_id',
        method: 'DELETE'
      },
      // Ticket Comments
      {
        // index
        name: 'Get a list of ticket comments',
        path: '/api/tickets/:ticket_id/comments',
        rawPath: '/api/tickets/:id/comments',
        method: 'GET'
      },
      {
        // create
        name: 'Create a ticket comment',
        path: '/api/tickets/:ticket_id/comments',
        rawPath: '/api/tickets/:id/comments',
        method: 'POST',
        formData: [
          { name: 'body', type: 'Text', isRequired: true },
        ]
      },
      {
        // update
        name: 'Update a ticket comment',
        path: '/api/tickets/:ticket_id/comments/:comment_id',
        rawPath: '/api/tickets/:id/comments/:comment_id',
        method: 'PUT',
        formData: [
          { name: 'body', type: 'Text', isRequired: true },
        ]
      },
      {
        // destroy
        name: 'Delete a ticket comment',
        path: '/api/tickets/:ticket_id/comments/:comment_id',
        rawPath: '/api/tickets/:id/comments/:comment_id',
        method: 'DELETE'
      },
      // Ticket Events
      {
        // index
        name: 'Get a list of ticket events',
        path: '/api/tickets/:ticket_id/events',
        rawPath: '/api/tickets/:id/events',
        method: 'GET',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
      // Subscriptions
      {
        // index
        name: 'Get a list of ticket subscriptions',
        path: '/api/tickets/:ticket_id/subscriptions',
        rawPath: '/api/tickets/:id/subscriptions',
        method: 'GET',
        note: 'Returns either zero or one subscription for the current user. This endpoint does not take any parameters.',
        noParams: true,
      },
      {
        // create
        name: 'Create a ticket subscription',
        path: '/api/tickets/:ticket_id/subscriptions',
        rawPath: '/api/tickets/:id/subscriptions',
        method: 'POST'
      },
      {
        // destroy
        name: 'Delete a ticket subscription',
        path: '/api/tickets/:ticket_id/subscriptions/:subscription_id',
        rawPath: '/api/tickets/:ticket_id/subscriptions/:id',
        method: 'DELETE'
      },
    ]
  },
  {
    title: 'Workspaces',
    desc: '',
    endpoints: [
      {
        // index
        name: 'Get a list of workspaces',
        path: '/api/workspaces',
        rawPath: '/api/workspaces',
        method: 'GET'
      },
      {
        // create
        name: 'Create a workspace',
        path: '/api/workspaces',
        rawPath: '/api/workspaces',
        method: 'POST',
        formData: [
          { name: 'project_id', type: 'Integer', isRequired: true },
          { name: 'name', type: 'String', isRequired: true },
          { name: 'description', type: 'Text', isRequired: false },
        ]
      },
      {
        // read
        name: 'Get a workspace',
        path: '/api/workspaces/:workspace_id',
        rawPath: '/api/workspaces/:id',
        method: 'GET'
      },
      {
        // update
        name: 'Update a workspace',
        path: '/api/workspaces/:workspace_id',
        rawPath: '/api/workspaces/:id',
        method: 'PUT',
        formData: [
          { name: 'name', type: 'String', isRequired: true },
          { name: 'description', type: 'Text', isRequired: true },
          { name: 'archive_merged_prs', type: 'Boolean', isRequired: true },
          { name: 'points', type: 'Boolean', isRequired: true },
          { name: 'priority_format', type: 'String', isRequired: true, note: 'Must be one of <code class="inline">number</code>, <code class="inline">name</code>, or <code class="inline">color</code>' },
          { name: 'priority', type: 'Boolean', isRequired: true },
          { name: 'upvotes', type: 'Boolean', isRequired: true },
          { name: 'use_category_labels', type: 'Boolean', isRequired: true },
          { name: 'add_category_labels_to_imported_cards', type: 'Boolean', isRequired: true },
          { name: 'should_use_fibonacci_scale', type: 'Boolean', isRequired: true },
          { name: 'add_category_labels_to_imported_cards', type: 'Boolean', isRequired: true },
          { name: 'auto_archive_closed_cards', type: 'Boolean', isRequired: true },
        ]
      },
      {
        // destroy
        name: 'Delete a workspace',
        path: '/api/workspaces/:workspace_id',
        rawPath: '/api/workspaces/:id',
        method: 'DELETE'
      },
      // User notification settings
      {
        name: 'Get your workspace subscription level settings',
        path: '/api/workspaces/:workspace_id/user_settings',
        rawPath: '/api/workspaces/:id/user_settings',
        method: 'GET',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
      {
        name: 'Get your workspace subscription level settings by id',
        path: '/api/workspaces/:workspace_id/user_settings/:user_workspace_setting_id',
        rawPath: '/api/workspaces/:id/user_settings/:user_workspace_setting_id',
        method: 'GET',
      },
      {
        name: 'Update your workspace subscription level settings',
        path: '/api/workspaces/:workspace_id/user_settings/:user_workspace_setting_id',
        rawPath: '/api/workspaces/:id/user_settings/:user_workspace_setting_id',
        method: 'PUT',
        formData: [
          { name: 'subscription_level', type: 'String', isRequired: true, note: 'Must be one of <code class="inline">following</code>, <code class="inline">not_following</code>, or <code class="inline">muted</code>' },
        ],
        note: 'This endpoint allows you to edit how Zube automatically subscribes you to Cards in your Workspace.'
      },
      // User In App Prefs
      {
        name: 'Get your workspace in app preferences',
        path: '/api/workspaces/:workspace_id/user_in_app_preferences',
        rawPath: '/api/workspaces/:id/user_in_app_preferences',
        method: 'GET',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
      {
        name: 'Get your workspace in app preferences by id',
        path: '/api/workspaces/:workspace_id/user_in_app_preferences/user_workspace_in_app_preference_id',
        rawPath: '/api/workspaces/:id/user_in_app_preferences/:user_workspace_in_app_preference_id',
        method: 'GET',
      },
      {
        name: 'Update your workspace in app preferences',
        path: '/api/workspaces/:workspace_id/user_in_app_preferences/user_workspace_in_app_preference_id',
        rawPath: '/api/workspaces/:id/user_in_app_preferences/:user_workspace_in_app_preference_id',
        method: 'PUT',
        formData: [
          { name: 'card_added_to_workspace', type: 'Boolean', isRequired: true },
          { name: 'card_assigned_to_self', type: 'Boolean', isRequired: true },
          { name: 'card_assignee_added', type: 'Boolean', isRequired: true },
          { name: 'card_card_linked', type: 'Boolean', isRequired: true },
          { name: 'card_column_changed', type: 'Boolean', isRequired: true },
          { name: 'card_comment_added', type: 'Boolean', isRequired: true },
          { name: 'card_comment_mention', type: 'Boolean', isRequired: true },
          { name: 'card_epic_added', type: 'Boolean', isRequired: true },
          { name: 'card_label_added', type: 'Boolean', isRequired: true },
          { name: 'card_mention', type: 'Boolean', isRequired: true },
          { name: 'card_milestone_added', type: 'Boolean', isRequired: true },
          { name: 'card_points_changed', type: 'Boolean', isRequired: true },
          { name: 'card_priority_changed', type: 'Boolean', isRequired: true },
          { name: 'card_sprint_added', type: 'Boolean', isRequired: true },
          { name: 'card_state_changed', type: 'Boolean', isRequired: true },
          { name: 'card_status_done', type: 'Boolean', isRequired: true },
          { name: 'card_status_in_progress', type: 'Boolean', isRequired: true },
          { name: 'card_status_in_review', type: 'Boolean', isRequired: true },
          { name: 'card_status_queued', type: 'Boolean', isRequired: true },
          { name: 'card_ticket_added', type: 'Boolean', isRequired: true },
          { name: 'pr_added_to_workspace', type: 'Boolean', isRequired: true },
          { name: 'pr_assigned_to_self', type: 'Boolean', isRequired: true },
          { name: 'pr_assignee_added', type: 'Boolean', isRequired: true },
          { name: 'pr_card_linked', type: 'Boolean', isRequired: true },
          { name: 'pr_column_changed', type: 'Boolean', isRequired: true },
          { name: 'pr_comment_added', type: 'Boolean', isRequired: true },
          { name: 'pr_comment_mention', type: 'Boolean', isRequired: true },
          { name: 'pr_epic_added', type: 'Boolean', isRequired: true },
          { name: 'pr_label_added', type: 'Boolean', isRequired: true },
          { name: 'pr_mention', type: 'Boolean', isRequired: true },
          { name: 'pr_merged', type: 'Boolean', isRequired: true },
          { name: 'pr_milestone_added', type: 'Boolean', isRequired: true },
          { name: 'pr_points_changed', type: 'Boolean', isRequired: true },
          { name: 'pr_priority_changed', type: 'Boolean', isRequired: true },
          { name: 'pr_sprint_added', type: 'Boolean', isRequired: true },
          { name: 'pr_state_changed', type: 'Boolean', isRequired: true },
          { name: 'pr_status_done', type: 'Boolean', isRequired: true },
          { name: 'pr_status_in_progress', type: 'Boolean', isRequired: true },
          { name: 'pr_status_in_review', type: 'Boolean', isRequired: true },
          { name: 'pr_status_queued', type: 'Boolean', isRequired: true },
          { name: 'pr_ticket_added', type: 'Boolean', isRequired: true },
          { name: 'sprint_card_added', type: 'Boolean', isRequired: true },
          { name: 'sprint_card_removed', type: 'Boolean', isRequired: true },
          { name: 'sprint_created', type: 'Boolean', isRequired: true },
          { name: 'sprint_end_date_changed', type: 'Boolean', isRequired: true },
          { name: 'sprint_start_date_changed', type: 'Boolean', isRequired: true },
          { name: 'sprint_state_changed', type: 'Boolean', isRequired: true },
        ]
      },
      // User Email Prefs
      {
        name: 'Get your workspace email preferences',
        path: '/api/workspaces/:workspace_id/user_email_preferences',
        rawPath: '/api/workspaces/:id/user_email_preferences',
        method: 'GET',
        note: 'This endpoint does not take any parameters.',
        noParams: true,
      },
      {
        name: 'Get your workspace email preferences by id',
        path: '/api/workspaces/:workspace_id/user_email_preferences/user_workspace_email_preference_id',
        rawPath: '/api/workspaces/:id/user_email_preferences/:user_workspace_email_preference_id',
        method: 'GET',
      },
      {
        name: 'Update your workspace email preferences',
        path: '/api/workspaces/:workspace_id/user_email_preferences/user_workspace_email_preference_id',
        rawPath: '/api/workspaces/:id/user_email_preferences/:user_workspace_email_preference_id',
        method: 'PUT',
        formData: [
          { name: 'email', type: 'String', isRequired: true },
          { name: 'card_added_to_workspace', type: 'Boolean', isRequired: true },
          { name: 'card_assigned_to_self', type: 'Boolean', isRequired: true },
          { name: 'card_assignee_added', type: 'Boolean', isRequired: true },
          { name: 'card_card_linked', type: 'Boolean', isRequired: true },
          { name: 'card_column_changed', type: 'Boolean', isRequired: true },
          { name: 'card_comment_added', type: 'Boolean', isRequired: true },
          { name: 'card_comment_mention', type: 'Boolean', isRequired: true },
          { name: 'card_epic_added', type: 'Boolean', isRequired: true },
          { name: 'card_label_added', type: 'Boolean', isRequired: true },
          { name: 'card_mention', type: 'Boolean', isRequired: true },
          { name: 'card_milestone_added', type: 'Boolean', isRequired: true },
          { name: 'card_points_changed', type: 'Boolean', isRequired: true },
          { name: 'card_priority_changed', type: 'Boolean', isRequired: true },
          { name: 'card_sprint_added', type: 'Boolean', isRequired: true },
          { name: 'card_state_changed', type: 'Boolean', isRequired: true },
          { name: 'card_status_done', type: 'Boolean', isRequired: true },
          { name: 'card_status_in_progress', type: 'Boolean', isRequired: true },
          { name: 'card_status_in_review', type: 'Boolean', isRequired: true },
          { name: 'card_status_queued', type: 'Boolean', isRequired: true },
          { name: 'card_ticket_added', type: 'Boolean', isRequired: true },
          { name: 'pr_added_to_workspace', type: 'Boolean', isRequired: true },
          { name: 'pr_assigned_to_self', type: 'Boolean', isRequired: true },
          { name: 'pr_assignee_added', type: 'Boolean', isRequired: true },
          { name: 'pr_card_linked', type: 'Boolean', isRequired: true },
          { name: 'pr_column_changed', type: 'Boolean', isRequired: true },
          { name: 'pr_comment_added', type: 'Boolean', isRequired: true },
          { name: 'pr_comment_mention', type: 'Boolean', isRequired: true },
          { name: 'pr_epic_added', type: 'Boolean', isRequired: true },
          { name: 'pr_label_added', type: 'Boolean', isRequired: true },
          { name: 'pr_mention', type: 'Boolean', isRequired: true },
          { name: 'pr_merged', type: 'Boolean', isRequired: true },
          { name: 'pr_milestone_added', type: 'Boolean', isRequired: true },
          { name: 'pr_points_changed', type: 'Boolean', isRequired: true },
          { name: 'pr_priority_changed', type: 'Boolean', isRequired: true },
          { name: 'pr_sprint_added', type: 'Boolean', isRequired: true },
          { name: 'pr_state_changed', type: 'Boolean', isRequired: true },
          { name: 'pr_status_done', type: 'Boolean', isRequired: true },
          { name: 'pr_status_in_progress', type: 'Boolean', isRequired: true },
          { name: 'pr_status_in_review', type: 'Boolean', isRequired: true },
          { name: 'pr_status_queued', type: 'Boolean', isRequired: true },
          { name: 'pr_ticket_added', type: 'Boolean', isRequired: true },
          { name: 'sprint_card_added', type: 'Boolean', isRequired: true },
          { name: 'sprint_card_removed', type: 'Boolean', isRequired: true },
          { name: 'sprint_created', type: 'Boolean', isRequired: true },
          { name: 'sprint_end_date_changed', type: 'Boolean', isRequired: true },
          { name: 'sprint_start_date_changed', type: 'Boolean', isRequired: true },
          { name: 'sprint_state_changed', type: 'Boolean', isRequired: true },
        ]
      },
      // workspace_card_templates
      {
        // index
        name: 'Get a list of workspace card templates',
        path: '/api/workspaces/:workspace_id/workspace_card_templates',
        rawPath: '/api/workspaces/:id/workspace_card_templates',
        method: 'GET'
      },
      {
        // create
        name: 'Create a workspace card template',
        path: '/api/workspaces/:workspace_id/workspace_card_templates',
        rawPath: '/api/workspaces/:id/workspace_card_templates',
        method: 'POST',
        formData: [
          { name: 'workspace_id', type: 'Integer', isRequired: true },
          { name: 'content', type: 'Text', isRequired: true },
          { name: 'title', type: 'Text', isRequired: true },
          { name: 'description', type: 'Text', isRequired: false },
        ]
      },
      {
        // read
        name: 'Get a workspace card template',
        path: '/api/workspaces/:workspace_id/workspace_card_templates/workspace_card_template_id',
        rawPath: '/api/workspaces/:id/workspace_card_templates/:workspace_card_template_id',
        method: 'GET'
      },
      {
        // update
        name: 'Update a workspace',
        path: '/api/workspaces/:workspace_id/workspace_card_templates/workspace_card_template_id',
        rawPath: '/api/workspaces/:id/workspace_card_templates/:workspace_card_template_id',
        method: 'PUT',
        formData: [
          { name: 'content', type: 'Text', isRequired: true },
          { name: 'title', type: 'Text', isRequired: true },
          { name: 'description', type: 'Text', isRequired: true },
        ]
      },
      {
        // destroy
        name: 'Delete a workspace',
        path: '/api/workspaces/:workspace_id/workspace_card_templates/workspace_card_template_id',
        rawPath: '/api/workspaces/:id/workspace_card_templates/:workspace_card_template_id',
        method: 'DELETE'
      },
    ]
  },
];

module.exports = sections;