Skip to content

Commit

Permalink
format schema table widths
Browse files Browse the repository at this point in the history
  • Loading branch information
max-ostapenko committed Nov 21, 2024
1 parent 21cc719 commit 3880747
Show file tree
Hide file tree
Showing 11 changed files with 50 additions and 504 deletions.
484 changes: 0 additions & 484 deletions src/content/docs/reference/blobs/har.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion src/content/docs/reference/blobs/page-metadata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ When a root page is being tested, secondary page candidates are collected using

- The page is linked from the root page
- The page is on the same origin as the root page
- THe page is not the same as the root page
- The page is not the same as the root page
- The link to the page is visible within the viewport

From the list of candidates, the link with the largest hit area is selected to be tested next. If that test fails, the next largest link is used.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/reference/blobs/page-payload.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Page payload blob
description: Reference docs for the page payload blob
---

_Appears in: [`pages` table](/reference/tables/pages/)_\
_Appears in: [`pages`](/reference/tables/pages/) table_\
_As: [`payload`](/reference/tables/pages/#payload)_

JSON-encoded WebPageTest result data for a page.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/reference/blobs/request-summary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Request summary blob
description: Reference docs for the request summary blob
---

_Appears in: [`requests` table](/reference/tables/requests/)_\
_Appears in: [`requests`](/reference/tables/requests/) table_\
_As: [`summary`](/reference/tables/requests/#summary)_

JSON-encoded summarization of request data.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/reference/custom-metrics/other.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Other custom metric
description: Reference docs for the other custom metric
---

_Appears in: [`custom_metrics` struct](/reference/structs/custom-metrics/)_\
_Appears in: [`custom_metrics`](/reference/structs/custom-metrics/) struct_\
_As: [`other`](/reference/structs/custom-metrics/#other)_

## Schema
Expand Down
24 changes: 24 additions & 0 deletions src/content/docs/reference/structs/custom-metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,30 @@ _As [`custom_metrics`](/reference/tables/pages/#custom_metrics)_

## Schema

<div style="width:150px">Field name</div> | <div style="width:50px">Type</div> | Description
---|---|---
`a11y` | `JSON` | Accessibility
`cms` | `JSON` | Content Management Systems
`cookies` | `JSON` | Cookie usage
`css_variables` | `JSON` | Use of CSS variables
`ecommerce` | `JSON` | E-commerce features
`element_count` | `JSON` | Number of elements on a page
`javascript` | `JSON` | JavaScript usage
`markup` | `JSON` | HTML markup
`media` | `JSON` | Media elements
`origin_trials` | `JSON` | Origin Trials
`performance` | `JSON` | Web performance
`privacy` | `JSON` | Privacy settings and policies. See the [`privacy`](/reference/custom-metrics/privacy/) custom metrics for more information
`responsive_images` | `JSON` | Responsive image techniques
`robots_txt` | `JSON` | robots.txt file
`security` | `JSON` | Security features
`structured_data` | `JSON` | Structured data
`third_parties` | `JSON` | Third-party resources
`well_known` | `JSON` | well-known URIs
`wpt_bodies` | `JSON` | Metrics derived from WebPageTest bodies object
`other` | `JSON` | See the [other](/reference/custom-metrics/other/) custom metrics for more information


### `a11y`

Type: `JSON`
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/reference/structs/feature.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Feature struct
description: Reference docs for the feature struct
---

_Appears in: [`pages` table](/reference/tables/pages/)_
_Appears in: [`pages`](/reference/tables/pages/) table_

Each header is a key-value pair corresponding to an HTTP header sent from or to the client: request and response headers, respectively.

Expand All @@ -25,4 +25,4 @@ Blink feature ID

### `type`

Blink feature type (css, default)
Blink feature type (css, default)
2 changes: 1 addition & 1 deletion src/content/docs/reference/structs/header.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Header struct
description: Reference docs for the header struct
---

_Appears in: [`requests` table](/reference/tables/requests/)_\
_Appears in: [`requests`](/reference/tables/requests/) table_\
_As: `request_headers`, `response_headers`_

Each header is a key-value pair corresponding to an HTTP header sent from or to the client: request and response headers, respectively.
Expand Down
6 changes: 6 additions & 0 deletions src/content/docs/reference/structs/technology.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ Technologies are detected by [Wappalyzer](https://www.wappalyzer.com/). Refer to

## Schema

<div style="width:100px">Field name</div> | <div style="width:115px">Type</div> | Description
---|---|---
`technology` | `STRING` | Name of the detected technology
`categories` | `ARRAY<STRING>` | List of categories to which this technology belongs
`info` | `ARRAY<STRING>` | Additional metadata about the detected technology, ie version number

### `technology`

Type: `STRING`
Expand Down
16 changes: 8 additions & 8 deletions src/content/docs/reference/tables/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { Tabs, TabItem } from '@astrojs/starlight/components';

## Schema

Field name | Type | Description
<div style="width:140px">Field name</div> | <div style="width:115px">Type</div> | Description
---|---|---
[`date`](#date) | `DATE` | YYYY-MM-DD format of the HTTP Archive monthly crawl
[`client`](#client) | `STRING` | Test environment: `'desktop'` or `'mobile'`
Expand All @@ -18,13 +18,13 @@ Field name | Type | Description
[`root_page`](#root_page) | `STRING` | The URL of the root page being tested, the origin followed by `/`
[`rank`](#rank) | `INTEGER` | Site popularity rank, from CrUX
[`wptid`](#wptid) | `STRING` | ID of the WebPageTest results
[`payload`](#payload) | [`HAR`](/reference/blobs/har/) | JSON-encoded WebPageTest results for the page
[`summary`](#summary) | [`Page summary`](/reference/structs/page-summary/) | JSON-encoded summarization of the page-level data
[`custom_metrics`](#custom_metrics) | [`Custom metrics`](/reference/structs/custom-metrics/) | JSON-encoded test results of the custom metrics
[`lighthouse`](#lighthouse) | [`Lighthouse`](/reference/blobs/lighthouse/) | JSON-encoded Lighthouse report
[`features`](#features) | <code>ARRAY&lt;<a href='/reference/structs/feature/'>Feature</a>></code> | Blink features detected at runtime
[`technologies`](#technologies) | <code>ARRAY&lt;<a href='/reference/structs/technology/'>Technology</a>></code> | Technologies detected at runtime
[`metadata`](#metadata) | [`Page metadata`](/reference/blobs/page-metadata/) | Additional metadata about the test
[`payload`](#payload) | `JSON` | JSON-encoded WebPageTest results for the page
[`summary`](#summary) | `JSON` | JSON-encoded summarization of the page-level data
[`custom_metrics`](#custom_metrics) | `RECORD` | JSON-encoded test results of the custom metrics
[`lighthouse`](#lighthouse) | `JSON` | JSON-encoded Lighthouse report
[`features`](#features) | <code>ARRAY\<RECORD\></code> | Blink features detected at runtime
[`technologies`](#technologies) | <code>ARRAY\<RECORD\></code> | Technologies detected at runtime
[`metadata`](#metadata) | `JSON` | Additional metadata about the test

### `date`

Expand Down
10 changes: 5 additions & 5 deletions src/content/docs/reference/tables/requests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { Tabs, TabItem } from '@astrojs/starlight/components';

## Schema

Field name | Type | Description
<div style="width:140px">Field name</div> | <div style="width:115px">Type</div> | Description
---|---|---
[`date`](#date) | `DATE` | YYYY-MM-DD format of the HTTP Archive monthly crawl
[`client`](#client) | `STRING` | Test environment: `'desktop'` or `'mobile'`
Expand All @@ -20,10 +20,10 @@ Field name | Type | Description
[`is_main_document`](#is_main_document) | `BOOLEAN` | Whether this request corresponds with the main HTML document of the page, which is the first HTML request after redirects
[`type`](#type) | `STRING` | Simplified description of the type of resource (script, html, css, text, other, etc)
[`index`](#index) | `INTEGER` | The sequential 0-based index of the request
[`payload`](#payload) | [`Request payload`](/reference/blobs/request-payload/) | JSON-encoded WebPageTest result data for this request
[`summary`](#summary) | [`Request summary`](/reference/blobs/request-summary/) | JSON-encoded summarization of request data
[`request_headers`](#request_headers) | <code>ARRAY&lt;<a href='/reference/structs/header/'>Header</a>></code> | Request headers
[`response_headers`](#response_headers) | <code>ARRAY&lt;<a href='/reference/structs/header/'>Header</a>></code> | Response headers
[`payload`](#payload) | `JSON` | JSON-encoded WebPageTest result data for this request
[`summary`](#summary) | `JSON` | JSON-encoded summarization of request data
[`request_headers`](#request_headers) | <code>ARRAY\<RECORD\></code> | Request headers
[`response_headers`](#response_headers) | <code>ARRAY\<RECORD\></code> | Response headers
[`response_body`](#response_body) | `STRING` | Text-based response body

### `date`
Expand Down

0 comments on commit 3880747

Please sign in to comment.