Skip to content

Commit

Permalink
docs(schema): typo
Browse files Browse the repository at this point in the history
  • Loading branch information
tripodsan committed Apr 24, 2019
1 parent bf8457b commit fa56cd9
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 49 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
* [Git URL](./giturl.schema.md)`https://ns.adobe.com/helix/shared/giturl` (Stabilizing)
* [Git URL](./staticgiturl.schema.md)`https://ns.adobe.com/helix/shared/staticgiturl` (Stabilizing)
* [Origin](./origin.schema.md)`https://ns.adobe.com/helix/shared/origin` (Stabilizing)
* [Performance](./performance.schema.md)`https://ns.adobe.com/helix/shared/performance` (Stabilizing)
* [Proxy Strain](./proxystrain.schema.md)`https://ns.adobe.com/helix/shared/proxystrain` (Stabilizing)
* [Redirect Rule](./redirectrule.schema.md)`https://ns.adobe.com/helix/shared/redirectrule` (Stabilizing)
* [Runtime Strain](./performance.schema.md)`https://ns.adobe.com/helix/shared/performance` (Stabilizing)
* [Runtime Strain](./runtimestrain.schema.md)`https://ns.adobe.com/helix/shared/runtimestrain` (Stabilizing)
* [Strains](./strains.schema.md)`https://ns.adobe.com/helix/shared/strains` (Stabilizing)

2 changes: 1 addition & 1 deletion docs/performance.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
],
"$id": "https://ns.adobe.com/helix/shared/performance",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Runtime Strain",
"title": "Performance",
"type": "object",
"meta:status": "stabilizing",
"description": "Performance testing details.",
Expand Down
76 changes: 38 additions & 38 deletions docs/performance.schema.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# Runtime Strain Schema
# Performance Schema

```
https://ns.adobe.com/helix/shared/performance
Expand All @@ -11,46 +11,46 @@ Performance testing details.
|----------|------------|--------|--------------|-------------------|-----------------------|------------|
| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | [performance.schema.json](performance.schema.json) |

# Runtime Strain Properties
# Performance Properties

| Property | Type | Required | Nullable | Defined by |
|----------|------|----------|----------|------------|
| [asset_count](#asset_count) | `number` | Optional | No | Runtime Strain (this schema) |
| [connection](#connection) | `enum` | Optional | No | Runtime Strain (this schema) |
| [consistently-interactive](#consistently-interactive) | `number` | Optional | No | Runtime Strain (this schema) |
| [css_body_size_in_bytes](#css_body_size_in_bytes) | `number` | Optional | No | Runtime Strain (this schema) |
| [css_size_in_bytes](#css_size_in_bytes) | `number` | Optional | No | Runtime Strain (this schema) |
| [device](#device) | `enum` | Optional | No | Runtime Strain (this schema) |
| [dom-size](#dom-size) | `number` | Optional | No | Runtime Strain (this schema) |
| [estimated-input-latency](#estimated-input-latency) | `number` | Optional | No | Runtime Strain (this schema) |
| [first-contentful-paint](#first-contentful-paint) | `number` | Optional | No | Runtime Strain (this schema) |
| [first-interactive](#first-interactive) | `number` | Optional | No | Runtime Strain (this schema) |
| [first-meaningful-paint](#first-meaningful-paint) | `number` | Optional | No | Runtime Strain (this schema) |
| [firstRender](#firstrender) | `number` | Optional | No | Runtime Strain (this schema) |
| [font_body_size_in_bytes](#font_body_size_in_bytes) | `number` | Optional | No | Runtime Strain (this schema) |
| [font_size_in_bytes](#font_size_in_bytes) | `number` | Optional | No | Runtime Strain (this schema) |
| [html_body_size_in_bytes](#html_body_size_in_bytes) | `number` | Optional | No | Runtime Strain (this schema) |
| [html_size_in_bytes](#html_size_in_bytes) | `number` | Optional | No | Runtime Strain (this schema) |
| [image_body_size_in_bytes](#image_body_size_in_bytes) | `number` | Optional | No | Runtime Strain (this schema) |
| [image_size_in_bytes](#image_size_in_bytes) | `number` | Optional | No | Runtime Strain (this schema) |
| [js-parse-compile](#js-parse-compile) | `number` | Optional | No | Runtime Strain (this schema) |
| [js_body_size_in_bytes](#js_body_size_in_bytes) | `number` | Optional | No | Runtime Strain (this schema) |
| [js_size_in_bytes](#js_size_in_bytes) | `number` | Optional | No | Runtime Strain (this schema) |
| [lighthouse-accessibility-score](#lighthouse-accessibility-score) | `number` | Optional | No | Runtime Strain (this schema) |
| [lighthouse-best-practices-score](#lighthouse-best-practices-score) | `number` | Optional | No | Runtime Strain (this schema) |
| [lighthouse-performance-score](#lighthouse-performance-score) | `number` | Optional | No | Runtime Strain (this schema) |
| [lighthouse-pwa-score](#lighthouse-pwa-score) | `number` | Optional | No | Runtime Strain (this schema) |
| [lighthouse-seo-score](#lighthouse-seo-score) | `number` | Optional | No | Runtime Strain (this schema) |
| [location](#location) | `enum` | Optional | No | Runtime Strain (this schema) |
| [oncontentload](#oncontentload) | `number` | Optional | No | Runtime Strain (this schema) |
| [onload](#onload) | `number` | Optional | No | Runtime Strain (this schema) |
| [page_body_size_in_bytes](#page_body_size_in_bytes) | `number` | Optional | No | Runtime Strain (this schema) |
| [page_size_in_bytes](#page_size_in_bytes) | `number` | Optional | No | Runtime Strain (this schema) |
| [page_wait_timing](#page_wait_timing) | `number` | Optional | No | Runtime Strain (this schema) |
| [speed_index](#speed_index) | `number` | Optional | No | Runtime Strain (this schema) |
| [time-to-first-byte](#time-to-first-byte) | `number` | Optional | No | Runtime Strain (this schema) |
| [visually_complete](#visually_complete) | `number` | Optional | No | Runtime Strain (this schema) |
| [visually_complete_85](#visually_complete_85) | `number` | Optional | No | Runtime Strain (this schema) |
| [asset_count](#asset_count) | `number` | Optional | No | Performance (this schema) |
| [connection](#connection) | `enum` | Optional | No | Performance (this schema) |
| [consistently-interactive](#consistently-interactive) | `number` | Optional | No | Performance (this schema) |
| [css_body_size_in_bytes](#css_body_size_in_bytes) | `number` | Optional | No | Performance (this schema) |
| [css_size_in_bytes](#css_size_in_bytes) | `number` | Optional | No | Performance (this schema) |
| [device](#device) | `enum` | Optional | No | Performance (this schema) |
| [dom-size](#dom-size) | `number` | Optional | No | Performance (this schema) |
| [estimated-input-latency](#estimated-input-latency) | `number` | Optional | No | Performance (this schema) |
| [first-contentful-paint](#first-contentful-paint) | `number` | Optional | No | Performance (this schema) |
| [first-interactive](#first-interactive) | `number` | Optional | No | Performance (this schema) |
| [first-meaningful-paint](#first-meaningful-paint) | `number` | Optional | No | Performance (this schema) |
| [firstRender](#firstrender) | `number` | Optional | No | Performance (this schema) |
| [font_body_size_in_bytes](#font_body_size_in_bytes) | `number` | Optional | No | Performance (this schema) |
| [font_size_in_bytes](#font_size_in_bytes) | `number` | Optional | No | Performance (this schema) |
| [html_body_size_in_bytes](#html_body_size_in_bytes) | `number` | Optional | No | Performance (this schema) |
| [html_size_in_bytes](#html_size_in_bytes) | `number` | Optional | No | Performance (this schema) |
| [image_body_size_in_bytes](#image_body_size_in_bytes) | `number` | Optional | No | Performance (this schema) |
| [image_size_in_bytes](#image_size_in_bytes) | `number` | Optional | No | Performance (this schema) |
| [js-parse-compile](#js-parse-compile) | `number` | Optional | No | Performance (this schema) |
| [js_body_size_in_bytes](#js_body_size_in_bytes) | `number` | Optional | No | Performance (this schema) |
| [js_size_in_bytes](#js_size_in_bytes) | `number` | Optional | No | Performance (this schema) |
| [lighthouse-accessibility-score](#lighthouse-accessibility-score) | `number` | Optional | No | Performance (this schema) |
| [lighthouse-best-practices-score](#lighthouse-best-practices-score) | `number` | Optional | No | Performance (this schema) |
| [lighthouse-performance-score](#lighthouse-performance-score) | `number` | Optional | No | Performance (this schema) |
| [lighthouse-pwa-score](#lighthouse-pwa-score) | `number` | Optional | No | Performance (this schema) |
| [lighthouse-seo-score](#lighthouse-seo-score) | `number` | Optional | No | Performance (this schema) |
| [location](#location) | `enum` | Optional | No | Performance (this schema) |
| [oncontentload](#oncontentload) | `number` | Optional | No | Performance (this schema) |
| [onload](#onload) | `number` | Optional | No | Performance (this schema) |
| [page_body_size_in_bytes](#page_body_size_in_bytes) | `number` | Optional | No | Performance (this schema) |
| [page_size_in_bytes](#page_size_in_bytes) | `number` | Optional | No | Performance (this schema) |
| [page_wait_timing](#page_wait_timing) | `number` | Optional | No | Performance (this schema) |
| [speed_index](#speed_index) | `number` | Optional | No | Performance (this schema) |
| [time-to-first-byte](#time-to-first-byte) | `number` | Optional | No | Performance (this schema) |
| [visually_complete](#visually_complete) | `number` | Optional | No | Performance (this schema) |
| [visually_complete_85](#visually_complete_85) | `number` | Optional | No | Performance (this schema) |

## asset_count

Expand Down
8 changes: 4 additions & 4 deletions docs/proxystrain.schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A strain is a combination of code and content that enables the creation of a dig
## Schema Hierarchy

* Proxy Strain `https://ns.adobe.com/helix/shared/proxystrain`
* [Runtime Strain](performance.schema.md) `https://ns.adobe.com/helix/shared/performance`
* [Performance](performance.schema.md) `https://ns.adobe.com/helix/shared/performance`


# Proxy Strain Properties
Expand All @@ -24,7 +24,7 @@ A strain is a combination of code and content that enables the creation of a dig
| [name](#name) | `string` | **Required** | No | Proxy Strain (this schema) |
| [origin](#origin) | complex | **Required** | No | Proxy Strain (this schema) |
| [params](#params) | `string[]` | Optional | No | Proxy Strain (this schema) |
| [perf](#perf) | Runtime Strain | Optional | No | Proxy Strain (this schema) |
| [perf](#perf) | Performance | Optional | No | Proxy Strain (this schema) |
| [redirects](#redirects) | Redirect Rule | Optional | No | Proxy Strain (this schema) |
| [sticky](#sticky) | `boolean` | Optional | No | Proxy Strain (this schema) |
| [url](#url) | `string` | Optional | No | Proxy Strain (this schema) |
Expand Down Expand Up @@ -153,13 +153,13 @@ All items must be of the type:
`perf`

* is optional
* type: Runtime Strain
* type: Performance
* defined in this schema

### perf Type


* [Runtime Strain](performance.schema.md)`https://ns.adobe.com/helix/shared/performance`
* [Performance](performance.schema.md)`https://ns.adobe.com/helix/shared/performance`



Expand Down
8 changes: 4 additions & 4 deletions docs/runtimestrain.schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A runtime strain is a combination of code and content that enables the creation
## Schema Hierarchy

* Runtime Strain `https://ns.adobe.com/helix/shared/runtimestrain`
* [Runtime Strain](performance.schema.md) `https://ns.adobe.com/helix/shared/performance`
* [Performance](performance.schema.md) `https://ns.adobe.com/helix/shared/performance`


# Runtime Strain Properties
Expand All @@ -27,7 +27,7 @@ A runtime strain is a combination of code and content that enables the creation
| [name](#name) | `string` | **Required** | No | | Runtime Strain (this schema) |
| [package](#package) | `string` | Optional | No | | Runtime Strain (this schema) |
| [params](#params) | `string[]` | Optional | No | | Runtime Strain (this schema) |
| [perf](#perf) | Runtime Strain | Optional | No | | Runtime Strain (this schema) |
| [perf](#perf) | Performance | Optional | No | | Runtime Strain (this schema) |
| [redirects](#redirects) | Redirect Rule | Optional | No | | Runtime Strain (this schema) |
| [static](#static) | complex | **Required** | No | | Runtime Strain (this schema) |
| [sticky](#sticky) | `boolean` | Optional | No | | Runtime Strain (this schema) |
Expand Down Expand Up @@ -235,13 +235,13 @@ All items must be of the type:
`perf`

* is optional
* type: Runtime Strain
* type: Performance
* defined in this schema

### perf Type


* [Runtime Strain](performance.schema.md)`https://ns.adobe.com/helix/shared/performance`
* [Performance](performance.schema.md)`https://ns.adobe.com/helix/shared/performance`



Expand Down
2 changes: 1 addition & 1 deletion src/schemas/performance.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
],
"$id": "https://ns.adobe.com/helix/shared/performance",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Runtime Strain",
"title": "Performance",
"type": "object",
"meta:status": "stabilizing",
"description": "Performance testing details.",
Expand Down

0 comments on commit fa56cd9

Please sign in to comment.