Template:SchemaDoc

Template documentation

Include this template on the talk page of any Schemas you create, and update it to reflect the status and usage of your schema.

This template categorizes the schema in a subcategory of Category:Schemas, according to status parameter and into the category Category:Schemas lacking a purge schedule.

Usage

parameters: status -- "in development", "active", or "inactive"; purge -- "none" or "Auto-purge after # days" or Special purge conditions. This field should be populated after discussing with data privacy stakeholders, see documentation. When using the default configuration, EventLogging data is automatically purged after 90 days. Warning: Changing the documentation here does not update the actual purging/preservation settings, this requires a patch to the whitelist.; contact -- linked <username>; project -- linked <page_name>; team -- <maintaining team> (do not link, used for categorization); sampling -- sampling rate for this schema; userinput -- If defined: schema contains user-inputed textual data

example

{{SchemaDoc
 | status=active
 | purge=Auto-purge after 90 days
 | contact=Halfak (WMF)
 | team=Research
 | project=R:Wikipedia article creation
 | sampling=1:1
 | userinput=true
}}

output

Maintainer:	Halfak (WMF)
Team:	Research
Project:	R:Wikipedia article creation
Status:	active
Sampling:	1:1
Purge:	Auto-purge after 90 days
Contains user-input text:	Yes

This page holds a JSON schema that specifies a data model for EventLogging.

Logging and client-side validation error rate on Grafana

Server-side validation errors in Logstash