Skip to content

Commit

Permalink
[#37, #67] add missing docs, remove deprecated taxonomy references (#69)
Browse files Browse the repository at this point in the history 
* [#37, #67] add missing docs, remove deprecated taxonomy references

* missing taxonomy updates

* update tests

* description updates

* changelog, visualizer js colors

* clean up links

* update readme screenshot, add db examples

* Update CHANGELOG.md

Co-authored-by: Cole Garbo <colegarbo@Ethycas-MacBook-Pro.local>
Co-authored-by: Thomas <thomas.lapiana+github@pm.me>
  • Loading branch information
@conceptualshark @ThomasLaPiana
3 people authored Aug 12, 2022
1 parent f7f60ac commit a1dd092
Show file tree
Hide file tree
Showing 42 changed files with 1,466 additions and 792 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@ The types of changes are:
* `Security` in case of vulnerabilities.

## [Unreleased](https://github.com/ethyca/fideslang/compare/1.1.0...main)

### Added

* New field `is_default` added to DataCategory, DataUse, DataSubject, and DataQualifier [#68](https://github.com/ethyca/fideslang/pull/68)

### Docs
* Updated documentation for new Data Category and Use taxonomy [#69](https://github.com/ethyca/fideslang/pull/69)


## 1.1.0

### Changed
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ The taxonomy is currently comprised of four classification groups that are used

Data Categories are labels used to describe the type of data processed by a system. You can assign one or more data categories to a field when classifying a system.

Data Categories are hierarchical with natural inheritance, meaning you can classify data coarsely with a high-level category (e.g. `user.provided` data), or you can classify it with greater precision using subclasses (e.g. `user.provided.identifiable.contact.email` data).
Data Categories are hierarchical with natural inheritance, meaning you can classify data coarsely with a high-level category (e.g. `user.contact` data), or you can classify it with greater precision using subclasses (e.g. `user.contact.email` data).

Learn more about [Data Categories in the taxonomy reference now](https://ethyca.github.io/fideslang/data_categories/).

### 2. Data Use Categories

Data Use Categories are labels that describe how, or for what purpose(s) a component of your system is using data. Similar to data categories, you can assign one or multiple Data Use Categories to a system.

Data Use Categories are also hierarchical with natural inheritance, meaning you can easily describe what you're using data for either coarsely (e.g. `provide.system.operations`) or with more precision using subclasses (e.g. `provide.system.operations.support.optimization`).
Data Use Categories are also hierarchical with natural inheritance, meaning you can easily describe what you're using data for either coarsely (e.g. `provide.service.operations`) or with more precision using subclasses (e.g. `provide.service.operations.support.optimization`).

Learn more about [Data Use Categories in the taxonomy reference now](https://ethyca.github.io/fideslang/data_uses/).

Expand Down
132 changes: 59 additions & 73 deletions data_files/data_categories.csv
View file
Original file line number Diff line number Diff line change
@@ -1,79 +1,65 @@
privacy_key,name,parent_key,description
data_category,Data Category,,
account,Account Data,data_category,Data related to a system account.
account.contact,Account Contact Data,account,Contact data related to a system account.
account.contact.city,Account City,account.contact,Account's city level address data.
account.contact.country,Account Country,account.contact,Account's country level address data.
account.contact.email,Account Email,account.contact,Account's email address.
account.contact.phone_number,Account Phone Number,account.contact,Account's phone number.
account.contact.postal_code,Account Postal Code,account.contact,Account's postal code.
account.contact.state,Account State,account.contact,Account's state level address data.
account.contact.street,Account Street,account.contact,Account's street level address.
account.payment,Payment Data,account,Payment data related to system account.
account.payment.financial_account_number,Account Payment Financial Account Number,account.payment,"Financial account number for an account's payment card, bank account, or other financial system."
system,System Data,data_category,"Data unique to, and under control of the system."
system.authentication,Authentication Data,system,Data used to manage access to the system.
system.operations,Operations Data,system,Data used for system operations.
user,User Data,data_category,"Data related to the user of the system, either provided directly or derived based on their usage."
user.derived,Derived Data,user,Data derived from user provided data or as a result of user actions in the system.
user.derived.identifiable,Derived User Identifiable Data,user.derived,"Derived data that is linked to, or identifies a user."
user.derived.identifiable.biometric_health,Biometric Health Data,user.derived.identifiable,Encoded characteristic collected about a user.
user.derived.identifiable.browsing_history,Browsing History,user.derived.identifiable,Content browsing history of a user.
user.derived.identifiable.demographic,Demographic Data,user.derived.identifiable,Demographic data about a user.
user.derived.identifiable.contact,Derived Contact Data,user.derived.identifiable,Contact data collected about a user.
user.derived.identifiable.device,Device Data,user.derived.identifiable,"Data related to a user's device, configuration and setting."
user.derived.identifiable.device.cookie_id,Cookie ID,user.derived.identifiable.device,Cookie unique identification number.
user.derived.identifiable.device.device_id,Device ID,user.derived.identifiable.device,Device unique identification number.
user.derived.identifiable.device.ip_address,IP Address,user.derived.identifiable.device,Unique identifier related to device connection.
user.derived.identifiable.gender,Derived Gender,user.derived.identifiable,Gender of an individual.
user.derived.identifiable.location,Location Data,user.derived.identifiable,Records of the location of a user.
user.derived.identifiable.media_consumption,Media Consumption Data,user.derived.identifiable,Media type consumption data of a user.
user.derived.identifiable.non_specific_age,Derived Non-Specific Age,user.derived.identifiable,Age range data.
user.derived.identifiable.observed,Observed Data,user.derived.identifiable,Data collected through observation of use of the system.
user.derived.identifiable.profiling,Profiling Data,user.derived.identifiable,Preference and interest data about a user.
user.derived.identifiable.race,Derived Race,user.derived.identifiable,Racial or ethnic origin data.
user.derived.identifiable.religious_belief,Derived Religious Belief,user.derived.identifiable,Religion or religious belief.
user.derived.identifiable.search_history,Search History,user.derived.identifiable,Records of search history and queries of a user.
user.derived.identifiable.sexual_orientation,Derived Sexual Orientation,user.derived.identifiable,Personal sex life or sexual data.
user.derived.identifiable.social,Social Data,user.derived.identifiable,Social activity and interaction data.
user.derived.identifiable.telemetry,Telemetry Data,user.derived.identifiable,User identifiable measurement data from system sensors and monitoring.
user.derived.identifiable.unique_id,Unique ID,user.derived.identifiable,Unique identifier for a user assigned through system use.
user.derived.identifiable.user_sensor,User Sensor Data,user.derived.identifiable,Measurement data derived about a user's environment through system use.
user.derived.identifiable.organization,Organization Identifiable Data,user.derived.identifiable,"Derived data that is linked to, or identifies an organization."
user.derived.identifiable.workplace,Derived Workplace,user.derived.identifiable,Organization of employment.
user.derived.nonidentifiable,Derived User Non-Identifiable Data,user.derived,Non-user identifiable data derived related to a user as a result of user actions in the system.
user.derived.nonidentifiable.sensor,Sensor Data,user.derived.nonidentifiable,Non-user identifiable measurement data derived from sensors and monitoring systems.
user.provided,User Provided Data,user,Data provided or created directly by a user of the system.
user.provided.identifiable,User Provided Identifiable Data,user.provided,Data provided or created directly by a user that is linked to or identifies a user.
user.provided.identifiable.biometric,Biometric Data,user.provided.identifiable,Encoded characteristics provided by a user.
user.provided.identifiable.childrens,Children's Data,user.provided.identifiable,Data relating to children.
user.provided.identifiable.contact,Provided Contact Data,user.provided.identifiable,User provided contact data for purposes other than account management.
user.provided.identifiable.contact.city,User Provided City,user.provided.identifiable.contact,User's city level address data.
user.provided.identifiable.contact.country,User Provided Country,user.provided.identifiable.contact,User's country level address data.
user.provided.identifiable.contact.email,User Provided Email,user.provided.identifiable.contact,User's provided email address.
user.provided.identifiable.contact.phone_number,User Provided Phone Number,user.provided.identifiable.contact,User's phone number.
user.provided.identifiable.contact.postal_code,User Provided Postal Code,user.provided.identifiable.contact,User's postal code.
user.provided.identifiable.contact.state,User Provided State,user.provided.identifiable.contact,User's state level address data.
user.provided.identifiable.contact.street,User Provided Street,user.provided.identifiable.contact,User's street level address data.
user.provided.identifiable.credentials,Credentials,user.provided.identifiable,User provided authentication data.
user.provided.identifiable.credentials.biometric_credentials,Biometric Credentials,user.provided.identifiable.credentials,Credentials for system authentication.
user.provided.identifiable.credentials.password,Password,user.provided.identifiable.credentials,Password for system authentication.
user.provided.identifiable.date_of_birth,Date of Birth,user.provided.identifiable,User's date of birth.
user.provided.identifiable.financial,Financial Data,user.provided.identifiable,Payment data and financial history.
user.provided.identifiable.financial.account_number,User Provided Financial Account Number,user.provided.identifiable.financial,"User's account number for a payment card, bank account, or other financial system."
user.provided.identifiable.gender,User Provided Gender,user.provided.identifiable,Gender of an individual.
user.provided.identifiable.genetic,Genetic Data,user.provided.identifiable,Data about the genetic makeup provided by a user.
user.provided.identifiable.government_id,Government ID,user.provided.identifiable,State provided identification data.
user.provided.identifiable.government_id.drivers_license_number,Driver's License Number,user.provided.identifiable.government_id,State issued driving identification number.
user.provided.identifiable.government_id.national_identification_number,National Identification Number,user.provided.identifiable.government_id,State issued personal identification number.
user.provided.identifiable.government_id.passport_number,Passport Number,user.provided.identifiable.government_id,State issued passport data.
user.provided.identifiable.health_and_medical,Health and Medical Data,user.provided.identifiable,Health records or individual's personal medical information.
user.provided.identifiable.job_title,Job Title,user.provided.identifiable,Professional data.
user.provided.identifiable.name,Name,user.provided.identifiable,User's real name.
user.provided.identifiable.non_specific_age,User Provided Non-Specific Age,user.provided.identifiable,Age range data.
user.provided.identifiable.political_opinion,Political Opinion,user.provided.identifiable,Data related to the individual's political opinions.
user.provided.identifiable.race,User Provided Race,user.provided.identifiable,Racial or ethnic origin data.
user.provided.identifiable.religious_belief,User Provided Religious Belief,user.provided.identifiable,Religion or religious belief.
user.provided.identifiable.sexual_orientation,User Provided Sexual Orientation,user.provided.identifiable,Personal sex life or sexual data.
user.provided.identifiable.workplace,User Provided Workplace,user.provided.identifiable,Organization of employment.
user.provided.nonidentifiable,User Provided Non-Identifiable Data,user.provided,Data provided or created directly by a user that is not identifiable.
user.account,Account Data,user,Data related to a user's system account.
user.account.contact,Account Contact Data,user.account,Contact data related to a system account.
user.account.contact.city,Account City,user.account.contact,Account's city level address data.
user.account.contact.country,Account Country,user.account.contact,Account's country level address data.
user.account.contact.email,Account Email,user.account.contact,Account's email address.
user.account.contact.phone_number,Account Phone Number,user.account.contact,Account's phone number.
user.account.contact.postal_code,Account Postal Code,user.account.contact,Account's postal code.
user.account.contact.state,Account State,user.account.contact,Account's state level address data.
user.account.contact.street,Account Street,user.account.contact,Account's street level address.
user.account.payment,Payment Data,user.account,Payment data related to system account.
user.account.payment.financial_account_number,Account Payment Financial Account Number,user.account.payment,"Financial account number for an account's payment card, bank account, or other financial system."
user.device,Device Data,user,"Data related to a user's device, configuration, and settings."
user.device.cookie_id,Cookie ID,user.device,Cookie unique identification number.
user.device.device_id,Device ID,user.device,Device unique identification number.
user.device.ip_address,IP Address,user.device,Unique identifier related to device connection.
user.contact,Contact Data,user,User contact data for purposes other than account management.
user.contact.city,User Contact City,user.contact,"User's city level address data."
user.contact.country,User Contact Country,user.contact,"User's country level address data."
user.contact.email,User Contact Email,user.contact,"User's email address."
user.contact.phone_number,User Contact Phone Number,user.contact,"User's phone number."
user.contact.postal_code,User Contact Postal Code,user.contact,"User's postal code."
user.contact.state,User Contact State,user.contact,"User's state level address data."
user.contact.street,User Contact Street,user.contact,"User's street level address data."
user.credentials,Credentials,user,User authentication data.
user.credentials.biometric_credentials,Biometric Credentials,user.credentials,Credentials for system authentication.
user.credentials.password,Password,user.credentials,Password for system authentication.
user.financial,Financial Data,user,Payment data and financial history.
user.financial.account_number,Financial Account Number,user.financial,"User's account number for a payment card, bank account, or other financial system."
user.government_id,Government ID,user,State provided identification data.
user.government_id.drivers_license_number,"Driver's License Number",user.government_id,State issued driving identification number.
user.government_id.national_identification_number,National Identification Number,user.government_id,State issued personal identification number.
user.government_id.passport_number,Passport Number,user.government_id,State issued passport data.
user.biometric_health,Biometric Health Data,user,Encoded characteristic collected about a user.
user.browsing_history,Browsing History,user,Content browsing history of a user.
user.childrens,Children's Data,user,Data relating to children.
user.date_of_birth,Date of Birth,user,"User's date of birth."
user.demographic,Demographic Data,user,Demographic data about a user.
user.gender,Gender,user,Gender of an individual.
user.genetic,Genetic Data,user,Data about the genetic makeup provided by a user.
user.health_and_medical,Health and Medical Data,user,"Health records or individual's personal medical information."
user.job_title,Job Title,user,Professional data.
user.location,Location Data,user,Records of the location of a user.
user.name,Name,user,"User's real name."
user.non_specific_age,Non-Specific Age,user,Age range data.
user.media_consumption,Media Consumption Data,user,Media type consumption data of a user.
user.observed,Observed Data,user,Data collected through observation of use of the system.
user.organization,Organization Data,user,Data that is linked to, or identifies an organization.
user.political_opinion,Political Opinion,user,"Data related to the individual's political opinions."
user.profiling,Profiling Data,user,Preference and interest data about a user.
user.race,Race,user,Racial or ethnic origin data.
user.religious_belief,Religious Belief,user,Religion or religious belief.
user.search_history,Search History,user,Records of search history and queries of a user.
user.sensor,Sensor Data,user,Non-user identifiable measurement data derived from sensors and monitoring systems.
user.sexual_orientation,Sexual Orientation,user,Personal sex life or sexual data.
user.social,Social Data,user,Social activity and interaction data.
user.telemetry,Telemetry Data,user,User measurement data from system sensors and monitoring.
user.unique_id,Unique ID,user,Unique identifier for a user assigned through system use.
user.user_sensor,User Sensor Data,user,Measurement data derived about a user's environment through system use.
user.workplace,Workplace,user,Organization of employment.
Loading

0 comments on commit a1dd092

Please sign in to comment.