Skip to content

Commit

Permalink
fix(chromeuxreport): update the API
Browse files Browse the repository at this point in the history 
#### chromeuxreport:v1
The following keys were changed:
- description
- resources.records.methods.queryRecord.description
- schemas.Bin.description
- schemas.Bin.properties.density.description
- schemas.Bin.properties.end.description
- schemas.Key.properties.effectiveConnectionType.description
- schemas.Key.properties.formFactor.description
- schemas.Key.properties.origin.description
- schemas.Key.properties.url.description
- schemas.Metric.description
- schemas.Metric.properties.histogram.description
- schemas.Metric.properties.percentiles.description
- schemas.Percentiles.description
- schemas.QueryRequest.description
- schemas.QueryRequest.properties.effectiveConnectionType.description
- schemas.QueryRequest.properties.formFactor.description
- schemas.QueryRequest.properties.metrics.description
- schemas.QueryRequest.properties.origin.description
- schemas.QueryRequest.properties.url.description
- schemas.QueryResponse.description
- schemas.QueryResponse.properties.urlNormalizationDetails.description
- schemas.Record.description
- schemas.Record.properties.key.description
- schemas.Record.properties.metrics.description
- schemas.UrlNormalization.description
- schemas.UrlNormalization.properties.normalizedUrl.description
  • Loading branch information
@yoshi-automation @JustinBeckwith
yoshi-automation authored and JustinBeckwith committed Aug 5, 2020
1 parent 2056439 commit 92e314c
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 41 deletions.
54 changes: 27 additions & 27 deletions discovery/chromeuxreport-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"baseUrl": "https://chromeuxreport.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Chrome UX Report",
"description": "The Chrome UX Report API lets you view real user experience data for millions of websites.\n",
"description": "The Chrome UX Report API lets you view real user experience data for millions of websites. ",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/web/tools/chrome-user-experience-report/api/reference",
"fullyEncodeReservedExpansion": true,
Expand Down Expand Up @@ -99,7 +99,7 @@
"records": {
"methods": {
"queryRecord": {
"description": "Queries the Chrome User Experience for a single `record` for a given site.\n\nReturns a `record` that contains one or more `metrics` corresponding to\nperformance data about the requested site.",
"description": "Queries the Chrome User Experience for a single `record` for a given site. Returns a `record` that contains one or more `metrics` corresponding to performance data about the requested site.",
"flatPath": "v1/records:queryRecord",
"httpMethod": "POST",
"id": "chromeuxreport.records.queryRecord",
Expand All @@ -116,20 +116,20 @@
}
}
},
"revision": "20200722",
"revision": "20200803",
"rootUrl": "https://chromeuxreport.googleapis.com/",
"schemas": {
"Bin": {
"description": "A bin is a discrete portion of data spanning from start to end, or if no\nend is given, then from start to +inf.\n\nA bin's start and end values are given in the value type of the metric it\nrepresents. For example, \"first contentful paint\" is measured in\nmilliseconds and exposed as ints, therefore its metric bins will use int32s\nfor its start and end types. However, \"cumulative layout shift\" is measured\nin unitless decimals and is exposed as a decimal encoded as a string,\ntherefore its metric bins will use strings for its value type.",
"description": "A bin is a discrete portion of data spanning from start to end, or if no end is given, then from start to +inf. A bin's start and end values are given in the value type of the metric it represents. For example, \"first contentful paint\" is measured in milliseconds and exposed as ints, therefore its metric bins will use int32s for its start and end types. However, \"cumulative layout shift\" is measured in unitless decimals and is exposed as a decimal encoded as a string, therefore its metric bins will use strings for its value type.",
"id": "Bin",
"properties": {
"density": {
"description": "The proportion of users that experienced this bin's value for the given\nmetric.",
"description": "The proportion of users that experienced this bin's value for the given metric.",
"format": "double",
"type": "number"
},
"end": {
"description": "End is the end of the data bin. If end is not populated, then the bin has\nno end and is valid from start to +inf.",
"description": "End is the end of the data bin. If end is not populated, then the bin has no end and is valid from start to +inf.",
"type": "any"
},
"start": {
Expand All @@ -144,11 +144,11 @@
"id": "Key",
"properties": {
"effectiveConnectionType": {
"description": "The effective connection type is the general connection class that all\nusers experienced for this record. This field uses the values [\"offline\",\n\"slow-2G\", \"2G\", \"3G\", \"4G\"] as specified in:\nhttps://wicg.github.io/netinfo/#effective-connection-types\n\nIf the effective connection type is unspecified, then aggregated data\nover all effective connection types will be returned.",
"description": "The effective connection type is the general connection class that all users experienced for this record. This field uses the values [\"offline\", \"slow-2G\", \"2G\", \"3G\", \"4G\"] as specified in: https://wicg.github.io/netinfo/#effective-connection-types If the effective connection type is unspecified, then aggregated data over all effective connection types will be returned.",
"type": "string"
},
"formFactor": {
"description": "The form factor is the device class that all users used to access the\nsite for this record.\n\nIf the form factor is unspecified, then aggregated data over all form\nfactors will be returned.",
"description": "The form factor is the device class that all users used to access the site for this record. If the form factor is unspecified, then aggregated data over all form factors will be returned.",
"enum": [
"ALL_FORM_FACTORS",
"PHONE",
Expand All @@ -164,36 +164,36 @@
"type": "string"
},
"origin": {
"description": "Origin specifies the origin that this record is for.\n\nNote: When specifying an origin, data for loads under this origin over\nall pages are aggregated into origin level user experience data.",
"description": "Origin specifies the origin that this record is for. Note: When specifying an origin, data for loads under this origin over all pages are aggregated into origin level user experience data.",
"type": "string"
},
"url": {
"description": "Url specifies a specific url that this record is for.\n\nNote: When specifying a \"url\" only data for that specific url will be\naggregated.",
"description": "Url specifies a specific url that this record is for. Note: When specifying a \"url\" only data for that specific url will be aggregated.",
"type": "string"
}
},
"type": "object"
},
"Metric": {
"description": "A `metric` is a set of user experience data for a single web performance\nmetric, like \"first contentful paint\". It contains a summary histogram of\nreal world Chrome usage as a series of `bins`.",
"description": "A `metric` is a set of user experience data for a single web performance metric, like \"first contentful paint\". It contains a summary histogram of real world Chrome usage as a series of `bins`.",
"id": "Metric",
"properties": {
"histogram": {
"description": "The histogram of user experiences for a metric. The histogram will have at\nleast one bin and the densities of all bins will add up to ~1.",
"description": "The histogram of user experiences for a metric. The histogram will have at least one bin and the densities of all bins will add up to ~1.",
"items": {
"$ref": "Bin"
},
"type": "array"
},
"percentiles": {
"$ref": "Percentiles",
"description": "Common useful percentiles of the Metric. The value type for the\npercentiles will be the same as the value types given for the Histogram\nbins."
"description": "Common useful percentiles of the Metric. The value type for the percentiles will be the same as the value types given for the Histogram bins."
}
},
"type": "object"
},
"Percentiles": {
"description": "Percentiles contains synthetic values of a metric at a given statistical\npercentile. These are used for estimating a metric's value as experienced\nby a percentage of users out of the total number of users.",
"description": "Percentiles contains synthetic values of a metric at a given statistical percentile. These are used for estimating a metric's value as experienced by a percentage of users out of the total number of users.",
"id": "Percentiles",
"properties": {
"p75": {
Expand All @@ -204,15 +204,15 @@
"type": "object"
},
"QueryRequest": {
"description": "Request payload sent by a physical web client.\n\nThis request includes all necessary context to load a particular\nuser experience record.",
"description": "Request payload sent by a physical web client. This request includes all necessary context to load a particular user experience record.",
"id": "QueryRequest",
"properties": {
"effectiveConnectionType": {
"description": "The effective connection type is a query dimension that specifies the\neffective network class that the record's data should belong to. This field\nuses the values [\"offline\", \"slow-2G\", \"2G\", \"3G\", \"4G\"] as specified in:\nhttps://wicg.github.io/netinfo/#effective-connection-types\n\nNote: If no effective connection type is specified, then a special record\nwith aggregated data over all effective connection types will be returned.",
"description": "The effective connection type is a query dimension that specifies the effective network class that the record's data should belong to. This field uses the values [\"offline\", \"slow-2G\", \"2G\", \"3G\", \"4G\"] as specified in: https://wicg.github.io/netinfo/#effective-connection-types Note: If no effective connection type is specified, then a special record with aggregated data over all effective connection types will be returned.",
"type": "string"
},
"formFactor": {
"description": "The form factor is a query dimension that specifies the device class that\nthe record's data should belong to.\n\nNote: If no form factor is specified, then a special record with\naggregated data over all form factors will be returned.",
"description": "The form factor is a query dimension that specifies the device class that the record's data should belong to. Note: If no form factor is specified, then a special record with aggregated data over all form factors will be returned.",
"enum": [
"ALL_FORM_FACTORS",
"PHONE",
Expand All @@ -228,25 +228,25 @@
"type": "string"
},
"metrics": {
"description": "The metrics that should be included in the response.\nIf none are specified then any metrics found will be returned.\n\nAllowed values: [\"first_contentful_paint\",\n\"first_input_delay\", \"largest_contentful_paint\",\n\"cumulative_layout_shift\"]",
"description": "The metrics that should be included in the response. If none are specified then any metrics found will be returned. Allowed values: [\"first_contentful_paint\", \"first_input_delay\", \"largest_contentful_paint\", \"cumulative_layout_shift\"]",
"items": {
"type": "string"
},
"type": "array"
},
"origin": {
"description": "The url pattern \"origin\" refers to a url pattern that is the origin of\na website.\n\nExamples: \"https://example.com\", \"https://cloud.google.com\"",
"description": "The url pattern \"origin\" refers to a url pattern that is the origin of a website. Examples: \"https://example.com\", \"https://cloud.google.com\"",
"type": "string"
},
"url": {
"description": "The url pattern \"url\" refers to a url pattern that is any arbitrary url.\n\nExamples: \"https://example.com/\",\n \"https://cloud.google.com/why-google-cloud/\"",
"description": "The url pattern \"url\" refers to a url pattern that is any arbitrary url. Examples: \"https://example.com/\", \"https://cloud.google.com/why-google-cloud/\"",
"type": "string"
}
},
"type": "object"
},
"QueryResponse": {
"description": "Response payload sent back to a physical web client.\n\nThis response contains the record found based on the identiers present in a\n`QueryRequest`. The returned response will have a record, and sometimes\ndetails on normalization actions taken on the request that were necessary to\nmake the request successful.",
"description": "Response payload sent back to a physical web client. This response contains the record found based on the identiers present in a `QueryRequest`. The returned response will have a record, and sometimes details on normalization actions taken on the request that were necessary to make the request successful.",
"id": "QueryResponse",
"properties": {
"record": {
Expand All @@ -255,35 +255,35 @@
},
"urlNormalizationDetails": {
"$ref": "UrlNormalization",
"description": "These are details about automated normalization actions that were taken in\norder to make the requested `url_pattern` valid."
"description": "These are details about automated normalization actions that were taken in order to make the requested `url_pattern` valid."
}
},
"type": "object"
},
"Record": {
"description": "Record is a single Chrome UX report data record. It contains use experience\nstatistics for a single url pattern and set of dimensions.",
"description": "Record is a single Chrome UX report data record. It contains use experience statistics for a single url pattern and set of dimensions.",
"id": "Record",
"properties": {
"key": {
"$ref": "Key",
"description": "Key defines all of the unique querying parameters needed to look up a user\nexperience record."
"description": "Key defines all of the unique querying parameters needed to look up a user experience record."
},
"metrics": {
"additionalProperties": {
"$ref": "Metric"
},
"description": "Metrics is the map of user experience data available for the record defined\nin the key field. Metrics are keyed on the metric name.\n\nAllowed key values: [\"first_contentful_paint\",\n\"first_input_delay\", \"largest_contentful_paint\",\n\"cumulative_layout_shift\"]",
"description": "Metrics is the map of user experience data available for the record defined in the key field. Metrics are keyed on the metric name. Allowed key values: [\"first_contentful_paint\", \"first_input_delay\", \"largest_contentful_paint\", \"cumulative_layout_shift\"]",
"type": "object"
}
},
"type": "object"
},
"UrlNormalization": {
"description": "Object representing the normalization actions taken to normalize a url to\nachieve a higher chance of successful lookup. These are simple automated\nchanges that are taken when looking up the provided `url_patten` would be\nknown to fail. Complex actions like following redirects are not handled.",
"description": "Object representing the normalization actions taken to normalize a url to achieve a higher chance of successful lookup. These are simple automated changes that are taken when looking up the provided `url_patten` would be known to fail. Complex actions like following redirects are not handled.",
"id": "UrlNormalization",
"properties": {
"normalizedUrl": {
"description": "The URL after any normalization actions. This is a valid user experience\nURL that could reasonably be looked up.",
"description": "The URL after any normalization actions. This is a valid user experience URL that could reasonably be looked up.",
"type": "string"
},
"originalUrl": {
Expand Down
Loading

0 comments on commit 92e314c

Please sign in to comment.