change_list-EXAMPLE.yml

# TODO: Add JSON Schema spec for this YAML
# TODO: handle copy model
# TODO: handle copy dashboard
# TODO: handle copy collection
# TODO: handle copy dependent content
# TODO: handle archive collection contents before update
# TODO: handle replace card
# TODO: handle replace model
# TODO: handle replace dashboard
# TODO: handle replace collection
# TODO: handle update database
# TODO: handle update schema
# TODO: handle update table
# TODO: handle update field
# TODO: handle update card
# TODO: handle update model
# TODO: handle update dashboard
changes:
  # use a `copy` clause if the target collection does not exist
  # you can leave `to` clauses blank if you want them to be generated
  # a fatal error will occur if there are any naming collisions detected
  # checks for naming collisions and does not overwrite
  - create: # EXAMPLE: copying a collection
      source:
        entity_id: collection_entity_id_1234
      changes:
        collection_id: collection_entity_id_5678
        database_id: 'Sample Database 2'
        dataset_query:
          database: 'Sample Database 2'
  - create: # EXAMPLE: copying a card
      source:
        entity_id: card_entity_id_12345
      changes:
        collection_id: collection_entity_id_5678
        database_id: 'Sample Database 2'
        dataset_query:
          database: 'Sample Database 2'
  # use a `replace` clause if the target collection does not exist
  # ?? existing contents in the collection will be unaltered unless they are included in the export and change list
  # every object`to` must be specified
  # a warning will occur if there are any naming collisions detected in the `to` clause
  # warns on naming collisions but does overwrite
  - replace:
      target:
        entity_id: collection_entity_id_5678
      source:
        entity_id: collection_entity_id_1234
      changes:
        authority_level: official
        name: 'zendesk issues - original'
        slug: zendesk_issues_original
      options:
        archive_existing_content: True # archives any content in target that is not included in source
# TODO: handle copy card
  - update: # Example: archiving content
      target:
        entity_id: question_entity_id_12345
      changes:
        archived: True