Skip to content

Doc examples

blackline.utils.doc_examples

DATASET = "\ndataset:\n key: dataset_key\n tags:\n - foo\n - bar\n name: user\n description: <resource description>\n meta:\n last_updated: '2021-01-01'\n version: 1.0.0\n data_categories:\n - user.contact\n data_qualifier: identified\n joint_controller:\n name: Dave\n address: Museumplein 10, 1071 DJ Amsterdam, Netherlands\n email: dave@organization.com\n phone: 020 573 2911\n third_country_transfers:\n - USA\n - CAN\n collections:\n user:\n name: user\n description: user data\n data_categories:\n - user.contact\n data_qualifier: identified\n fields:\n - name: email\n description: user email\n data_categories:\n - user.contact.email\n data_qualifier: identified\n deidentifier:\n type: replace\n value: fake@email.com\n period: P365D\n - name: name\n description: user name\n data_categories:\n - user.name\n data_qualifier: identified\n deidentifier:\n type: redact\n period: P365D\n datetime_field:\n name: created_at\n" module-attribute

ORGANIZATION = '\norganization:\n key: organization_key\n tags:\n - foo\n - bar\n name: organization_foo\n description: organization description\n controller:\n name: Bob\n address: Museumplein 10, 1071 DJ Amsterdam, Netherlands\n email: bob@organization.com\n phone: 020 573 2911\n data_protection_officer:\n name: Alice\n address: Museumplein 10, 1071 DJ Amsterdam, Netherlands\n email: alice@organization.com\n phone: 020 573 2911\n representative:\n name: Carol [optional]\n address: Museumplein 10, 1071 DJ Amsterdam, Netherlands\n email: carol@organization.com\n phone: 020 573 2911\n' module-attribute

RESOURCE = '\nresource:\n key: resource_key\n tags:\n - foo\n - bar\n name: <resource name>\n description: <resource description>\n resource_type: Service\n data_responsibility_title: Processor\n privacy_declarations:\n - name: Privacy Policy\n data_categories:\n - user.device.cookie_id\n - user.contact\n data_use: improve.system\n data_subjects:\n - Customer\n data_qualifier: Aggregated\n dependencies:\n - system_key\n joint_controller:\n name: Dave\n address: Museumplein 10, 1071 DJ Amsterdam, Netherlands\n email: dave@organization.com\n phone: 020 573 2911\n third_country_transfers:\n - USA\n - CAN\n administrating_department: engineering\n data_protection_impact_assessment:\n is_required: true\n status: Complete\n link: https://example.org/analytics_system_data_protection_impact_assessment\n' module-attribute

SQLITE = '\nprofiles:\n dev:\n type: sqlite\n config:\n connection:\n database: "dev.db"\n uri: true\n prd:\n type: sqlite\n config:\n connection:\n database: "prd.db"\n uri: true\n' module-attribute

SYSTEM = '\nsystem:\n key: system_key\n tags:\n - foo\n - bar\n name: system_foo\n description: <system description> [optional]\n\n' module-attribute