CSS Test Suite Manager

API Resource: specifications — https://test.csswg.org/shepherd/api/spec/{?spec,sections,anchors,draft,insync}

Overview:

Write This...

Arguments:

	type	description
spec	<string>	short name of spec	optional, single <spec-data> returned if present
sections	<bool>	include section data	optional
anchors	<bool>	include all anchor data	optional
draft	<bool>	include draft data	optional
links	<bool>	include link data	optional
backlinks	<bool>	include backlink data	optional
insync	<bool>	check if spec is in sync, must provide spec, excludes other options	optional

Returns:

{
  _<spec-name>: <spec-data>,
  ...
}


<spec-data> = {
  name: <string>,
  alt_name*: <string>,
  short_name: <string>,
  level: <int>,
  title: <string>,
  description*: <string>,
  base_uri*: <string>,
  draft_uri*: <string>,
  home_uri*: <string>,
  pages*: <string> ('multiple' or 'single'),
  domain*: <string>,
  working_group*: <string>,
  status*: <string>,
  status_deadline*: <iso-date UTC>,
  work_status*: <string>,
  modified_date*: <iso-date UTC>,
  etag*: <string>,
  draft_modified_date*: <iso-date UTC>,
  draft_etag*: <string>,
  abstract*: <string>,
  sync_date*: <iso-date UTC>,
  sections: [<anchor-data>, ...] (only present if 'sections' arg is true),
  draft_sections: [<anchor-data>, ...] (only present if 'sections' and 'draft' args are true),
  anchors: [<anchor-data>, ...] (only present if 'anchors' arg is true),
  draft_anchors: [<anchor-data>, ...] (only present if 'anchors' and 'draft' args are true),
  backlinks: [<backlink-data>, ...] (only present if 'backlinks' arg is true),
  draft_backlinks: [<backlink-data>, ...] (only present if 'backlinks' and 'draft' args are true)
}


<anchor-data> = {
  name: <string>,
  type: <string>,
  for*: [<string>, ...],
  title*: <string>,
  section*: <bool>,
  scope*: <string> ('defines', 'obsoletes', or 'extends'),
  obsoletes*: <string> (present when 'scope' == 'obsoletes'),
  normative*: <bool>,
  export*: <bool>,
  linking_text*: [<string>, ...],
  preserve_case*: <bool>,
  uri: <string>,
  links*: [<link-data>, ...],
  children*: [<anchor-data>, ...]
}


<link-data> = {
  spec: <string>,
  spec_type: <string>,
  href*: <string>
}


<backlink-data> = {
  spec: <string>,
  spec_type: <string>,
  parent_name: <string>,
  name: <string>,
  href*: <string>
}

API Resource: technical_report — https://test.csswg.org/shepherd/api/tr/{?spec, group}

Overview:

Write This...

Arguments:

	type	description
spec	<string>	short name of spec	optional, single <tr-data> returned if present
group	<string>	name of working group	optional, filter resuts to products of group

Returns:

{
  <spec-uri>: <tr-data>,
  ...
}


<tr-data> = {
  uri: <string>,
  status: <string>,
  type*: <string>,
  title: <string>,
  date: <iso-date UTC>,
  canonical_uri*: <string>,
  short_name*: <string>,
  obsoletes*: <string>,
  group_uris*: [<string>, ...],
  groups*: [<string>, ...],
  previous_edition_uri*: <string>,
  errata_uri*: <string>,
  translation_uri*: <string>,
  patent_rules_uri*: <string>,
  draft_uri*: <string>,
  former_short_names*: [<string>, ...],
  former_uris*: [<string>, ...],
  supersedes_uris*: [<string>, ...],
  editors: [<user-data>, ...]
}


<user-data> = {
  id: <int>,
  name*: <string>,
  ip_address*: <string>,
  full_name*: <string>,
  alt_name*: <string>,
  email*: <string>,
  alt_email*: <string>,
  uri*: <string>,
  organization*: <string>,
  display_email*: <bool>
}

API Resource: test_flags — https://test.csswg.org/shepherd/api/flag/{?flag}

Overview:

none

Arguments:

	type	description
flag	<flag-name>	name of flag	optional, single <flag-data> returned if present

Returns:

{
  _<flag-name>: <flag-data>,
  ...
}


<flag-data> = {
  name: <string>,
  title: <string>,
  description*: <string>,
  html_description*: <string>,
  set_test*: <string>,
  unset_test*: <string>
}

API Resource: test_formats — https://test.csswg.org/shepherd/api/format/{?format}

Overview:

none

Arguments:

	type	description
format	<format-name>	name of format	optional, single <format-data> returned if present

Returns:

{
  _<format-name>: <format-data>,
  ...
}


<format-data> = {
  name: <string>,
  title: <string>,
  description*: <string>,
  mime_type*: <string>,
  home_uri*: <string>,
  path*: <string>,
  extension*: <string>,
  filter*: <string>
}

API Resource: test_suites — https://test.csswg.org/shepherd/api/suite/{?suite,spec}

Overview:

none

Arguments:

	type	description
repo	<string>	name of repository	optional, suites for repository returned if present
suite	<suite-name>	name of test suite	optional, single <suite-data> returned if present
spec	<string>	short name of spec	optional, suites for single spec returned if present

Returns:

{
  _<suite-name>: <suite-data>,
  ...
}


<suite-data> = {
  id: <int>,
  name: <string>,
  alt_name*: <string>,
  title*: <string>,
  description*: <string>,
  annotation_title*: <string>,
  status: <string>,
  repo: <string>,
  uri: <string>,
  active*: <bool>,
  build*: <bool>,
  build_date*: <iso-date UTC>,
  build_date_user*: <user-date> (build_date in user time zone and format),
  lock_date*: <iso-date UTC>,
  lock_date_user*: <user-date> (lock_date in user time zone and format),
  specs: [<string>, ...],
  owners*: [<user-data>, ...],
  formats*: [<string>, ...],
  optional_flags*: [<string>, ...]
}


<user-data> = {
  id: <int>,
  name*: <string>,
  ip_address*: <string>,
  full_name*: <string>,
  alt_name*: <string>,
  email*: <string>,
  alt_email*: <string>,
  uri*: <string>,
  organization*: <string>,
  display_email*: <bool>
}