Skip to content

Commit

Permalink
feat(pagespeedonline): update the api
Browse files Browse the repository at this point in the history
#### pagespeedonline:v5

The following keys were added:
- schemas.AuditRefs.properties.acronym.type (Total Keys: 1)
- schemas.AuditRefs.properties.relevantAudits (Total Keys: 2)
- schemas.LighthouseAuditResultV5.properties.numericUnit.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.calculatorLink.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.dropdownCopyJSON.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.dropdownDarkTheme.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.dropdownPrintExpanded.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.dropdownPrintSummary.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.dropdownSaveGist.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.dropdownSaveHTML.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.dropdownSaveJSON.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.dropdownViewer.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.footerIssue.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.runtimeDesktopEmulation.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.runtimeMobileEmulation.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.runtimeNoEmulation.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.runtimeSettingsAxeVersion.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.runtimeSettingsBenchmark.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.runtimeSettingsCPUThrottling.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.runtimeSettingsChannel.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.runtimeSettingsDevice.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.runtimeSettingsFetchTime.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.runtimeSettingsNetworkThrottling.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.runtimeSettingsUA (Total Keys: 2)
- schemas.RendererFormattedStrings.properties.runtimeUnknown.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.showRelevantAudits.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.snippetCollapseButtonLabel.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.snippetExpandButtonLabel.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.thirdPartyResourcesLabel.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.throttlingProvided.type (Total Keys: 1)
- schemas.RendererFormattedStrings.properties.viewTreemapLabel.type (Total Keys: 1)
  • Loading branch information
yoshi-automation committed Jun 5, 2021
1 parent 5dbaaad commit 47d41c5
Show file tree
Hide file tree
Showing 2 changed files with 199 additions and 3 deletions.
55 changes: 54 additions & 1 deletion docs/dyn/pagespeedonline_v5.pagespeedapi.html
Expand Up @@ -133,6 +133,7 @@ <h3>Method Details</h3>
&quot;errorMessage&quot;: &quot;A String&quot;, # An error message from a thrown error inside the audit.
&quot;explanation&quot;: &quot;A String&quot;, # An explanation of the errors in the audit.
&quot;id&quot;: &quot;A String&quot;, # The audit&#x27;s id.
&quot;numericUnit&quot;: &quot;A String&quot;, # The unit of the numeric_value field. Used to format the numeric value for display.
&quot;numericValue&quot;: 3.14, # A numeric value that has a meaning specific to the audit, e.g. the number of nodes in the DOM or the timestamp of a specific load event. More information can be found in the audit details, if present.
&quot;score&quot;: &quot;&quot;, # The score of the audit, can be null.
&quot;scoreDisplayMode&quot;: &quot;A String&quot;, # The enumerated score display mode.
Expand All @@ -144,8 +145,12 @@ <h3>Method Details</h3>
&quot;accessibility&quot;: { # A Lighthouse category. # The accessibility category, containing all accessibility related audits.
&quot;auditRefs&quot;: [ # An array of references to all the audit members of this category.
{ # A light reference to an audit by id, used to group and weight audits in a given category.
&quot;acronym&quot;: &quot;A String&quot;, # The conventional acronym for the audit/metric.
&quot;group&quot;: &quot;A String&quot;, # The category group that the audit belongs to (optional).
&quot;id&quot;: &quot;A String&quot;, # The audit ref id.
&quot;relevantAudits&quot;: [ # Any audit IDs closely relevant to this one.
&quot;A String&quot;,
],
&quot;weight&quot;: 3.14, # The weight this audit&#x27;s score has on the overall category score.
},
],
Expand All @@ -158,8 +163,12 @@ <h3>Method Details</h3>
&quot;best-practices&quot;: { # A Lighthouse category. # The best practices category, containing all best practices related audits.
&quot;auditRefs&quot;: [ # An array of references to all the audit members of this category.
{ # A light reference to an audit by id, used to group and weight audits in a given category.
&quot;acronym&quot;: &quot;A String&quot;, # The conventional acronym for the audit/metric.
&quot;group&quot;: &quot;A String&quot;, # The category group that the audit belongs to (optional).
&quot;id&quot;: &quot;A String&quot;, # The audit ref id.
&quot;relevantAudits&quot;: [ # Any audit IDs closely relevant to this one.
&quot;A String&quot;,
],
&quot;weight&quot;: 3.14, # The weight this audit&#x27;s score has on the overall category score.
},
],
Expand All @@ -172,8 +181,12 @@ <h3>Method Details</h3>
&quot;performance&quot;: { # A Lighthouse category. # The performance category, containing all performance related audits.
&quot;auditRefs&quot;: [ # An array of references to all the audit members of this category.
{ # A light reference to an audit by id, used to group and weight audits in a given category.
&quot;acronym&quot;: &quot;A String&quot;, # The conventional acronym for the audit/metric.
&quot;group&quot;: &quot;A String&quot;, # The category group that the audit belongs to (optional).
&quot;id&quot;: &quot;A String&quot;, # The audit ref id.
&quot;relevantAudits&quot;: [ # Any audit IDs closely relevant to this one.
&quot;A String&quot;,
],
&quot;weight&quot;: 3.14, # The weight this audit&#x27;s score has on the overall category score.
},
],
Expand All @@ -186,8 +199,12 @@ <h3>Method Details</h3>
&quot;pwa&quot;: { # A Lighthouse category. # The Progressive-Web-App (PWA) category, containing all pwa related audits.
&quot;auditRefs&quot;: [ # An array of references to all the audit members of this category.
{ # A light reference to an audit by id, used to group and weight audits in a given category.
&quot;acronym&quot;: &quot;A String&quot;, # The conventional acronym for the audit/metric.
&quot;group&quot;: &quot;A String&quot;, # The category group that the audit belongs to (optional).
&quot;id&quot;: &quot;A String&quot;, # The audit ref id.
&quot;relevantAudits&quot;: [ # Any audit IDs closely relevant to this one.
&quot;A String&quot;,
],
&quot;weight&quot;: 3.14, # The weight this audit&#x27;s score has on the overall category score.
},
],
Expand All @@ -200,8 +217,12 @@ <h3>Method Details</h3>
&quot;seo&quot;: { # A Lighthouse category. # The Search-Engine-Optimization (SEO) category, containing all seo related audits.
&quot;auditRefs&quot;: [ # An array of references to all the audit members of this category.
{ # A light reference to an audit by id, used to group and weight audits in a given category.
&quot;acronym&quot;: &quot;A String&quot;, # The conventional acronym for the audit/metric.
&quot;group&quot;: &quot;A String&quot;, # The category group that the audit belongs to (optional).
&quot;id&quot;: &quot;A String&quot;, # The audit ref id.
&quot;relevantAudits&quot;: [ # Any audit IDs closely relevant to this one.
&quot;A String&quot;,
],
&quot;weight&quot;: 3.14, # The weight this audit&#x27;s score has on the overall category score.
},
],
Expand Down Expand Up @@ -235,20 +256,52 @@ <h3>Method Details</h3>
&quot;i18n&quot;: { # Message containing the i18n data for the LHR - Version 1. # The internationalization strings that are required to render the LHR.
&quot;rendererFormattedStrings&quot;: { # Message holding the formatted strings used in the renderer. # Internationalized strings that are formatted to the locale in configSettings.
&quot;auditGroupExpandTooltip&quot;: &quot;A String&quot;, # The tooltip text on an expandable chevron icon.
&quot;calculatorLink&quot;: &quot;A String&quot;, # Text link pointing to the Lighthouse scoring calculator. This link immediately follows a sentence stating the performance score is calculated from the perf metrics.
&quot;crcInitialNavigation&quot;: &quot;A String&quot;, # The label for the initial request in a critical request chain.
&quot;crcLongestDurationLabel&quot;: &quot;A String&quot;, # The label for values shown in the summary of critical request chains.
&quot;dropdownCopyJSON&quot;: &quot;A String&quot;, # Option in a dropdown menu that copies the Lighthouse JSON object to the system clipboard.
&quot;dropdownDarkTheme&quot;: &quot;A String&quot;, # Option in a dropdown menu that toggles the themeing of the report between Light(default) and Dark themes.
&quot;dropdownPrintExpanded&quot;: &quot;A String&quot;, # Option in a dropdown menu that opens a full Lighthouse report in a print dialog.
&quot;dropdownPrintSummary&quot;: &quot;A String&quot;, # Option in a dropdown menu that opens a small, summary report in a print dialog.
&quot;dropdownSaveGist&quot;: &quot;A String&quot;, # Option in a dropdown menu that saves the current report as a new GitHub Gist.
&quot;dropdownSaveHTML&quot;: &quot;A String&quot;, # Option in a dropdown menu that saves the Lighthouse report HTML locally to the system as a &#x27;.html&#x27; file.
&quot;dropdownSaveJSON&quot;: &quot;A String&quot;, # Option in a dropdown menu that saves the Lighthouse JSON object to the local system as a &#x27;.json&#x27; file.
&quot;dropdownViewer&quot;: &quot;A String&quot;, # Option in a dropdown menu that opens the current report in the Lighthouse Viewer Application.
&quot;errorLabel&quot;: &quot;A String&quot;, # The label shown next to an audit or metric that has had an error.
&quot;errorMissingAuditInfo&quot;: &quot;A String&quot;, # The error string shown next to an erroring audit.
&quot;footerIssue&quot;: &quot;A String&quot;, # Label for button to create an issue against the Lighthouse GitHub project.
&quot;labDataTitle&quot;: &quot;A String&quot;, # The title of the lab data performance category.
&quot;lsPerformanceCategoryDescription&quot;: &quot;A String&quot;, # The disclaimer shown under performance explaning that the network can vary.
&quot;lsPerformanceCategoryDescription&quot;: &quot;A String&quot;, # The disclaimer shown under performance explaining that the network can vary.
&quot;manualAuditsGroupTitle&quot;: &quot;A String&quot;, # The heading shown above a list of audits that were not computerd in the run.
&quot;notApplicableAuditsGroupTitle&quot;: &quot;A String&quot;, # The heading shown above a list of audits that do not apply to a page.
&quot;opportunityResourceColumnLabel&quot;: &quot;A String&quot;, # The heading for the estimated page load savings opportunity of an audit.
&quot;opportunitySavingsColumnLabel&quot;: &quot;A String&quot;, # The heading for the estimated page load savings of opportunity audits.
&quot;passedAuditsGroupTitle&quot;: &quot;A String&quot;, # The heading that is shown above a list of audits that are passing.
&quot;runtimeDesktopEmulation&quot;: &quot;A String&quot;, # Descriptive explanation for emulation setting when emulating a generic desktop form factor, as opposed to a mobile-device like form factor.
&quot;runtimeMobileEmulation&quot;: &quot;A String&quot;, # Descriptive explanation for emulation setting when emulating a Nexus 5X mobile device.
&quot;runtimeNoEmulation&quot;: &quot;A String&quot;, # Descriptive explanation for emulation setting when no device emulation is set.
&quot;runtimeSettingsAxeVersion&quot;: &quot;A String&quot;, # Label for a row in a table that shows the version of the Axe library used
&quot;runtimeSettingsBenchmark&quot;: &quot;A String&quot;, # Label for a row in a table that shows the estimated CPU power of the machine running Lighthouse. Example row values: 532, 1492, 783.
&quot;runtimeSettingsCPUThrottling&quot;: &quot;A String&quot;, # Label for a row in a table that describes the CPU throttling conditions that were used during a Lighthouse run, if any.
&quot;runtimeSettingsChannel&quot;: &quot;A String&quot;, # Label for a row in a table that shows in what tool Lighthouse is being run (e.g. The lighthouse CLI, Chrome DevTools, Lightrider, WebPageTest, etc).
&quot;runtimeSettingsDevice&quot;: &quot;A String&quot;, # Label for a row in a table that describes the kind of device that was emulated for the Lighthouse run. Example values for row elements: &#x27;No Emulation&#x27;, &#x27;Emulated Desktop&#x27;, etc.
&quot;runtimeSettingsFetchTime&quot;: &quot;A String&quot;, # Label for a row in a table that shows the time at which a Lighthouse run was conducted; formatted as a timestamp, e.g. Jan 1, 1970 12:00 AM UTC.
&quot;runtimeSettingsNetworkThrottling&quot;: &quot;A String&quot;, # Label for a row in a table that describes the network throttling conditions that were used during a Lighthouse run, if any.
&quot;runtimeSettingsTitle&quot;: &quot;A String&quot;, # Title of the Runtime settings table in a Lighthouse report. Runtime settings are the environment configurations that a specific report used at auditing time.
&quot;runtimeSettingsUA&quot;: &quot;A String&quot;, # Label for a row in a table that shows the User Agent that was detected on the Host machine that ran Lighthouse.
&quot;runtimeSettingsUANetwork&quot;: &quot;A String&quot;, # Label for a row in a table that shows the User Agent that was used to send out all network requests during the Lighthouse run.
&quot;runtimeSettingsUrl&quot;: &quot;A String&quot;, # Label for a row in a table that shows the URL that was audited during a Lighthouse run.
&quot;runtimeUnknown&quot;: &quot;A String&quot;, # Descriptive explanation for a runtime setting that is set to an unknown value.
&quot;scorescaleLabel&quot;: &quot;A String&quot;, # The label that explains the score gauges scale (0-49, 50-89, 90-100).
&quot;showRelevantAudits&quot;: &quot;A String&quot;, # Label preceding a radio control for filtering the list of audits. The radio choices are various performance metrics (FCP, LCP, TBT), and if chosen, the audits in the report are hidden if they are not relevant to the selected metric.
&quot;snippetCollapseButtonLabel&quot;: &quot;A String&quot;, # The label for the button to show only a few lines of a snippet
&quot;snippetExpandButtonLabel&quot;: &quot;A String&quot;, # The label for the button to show all lines of a snippet
&quot;thirdPartyResourcesLabel&quot;: &quot;A String&quot;, # This label is for a filter checkbox above a table of items
&quot;throttlingProvided&quot;: &quot;A String&quot;, # Descriptive explanation for environment throttling that was provided by the runtime environment instead of provided by Lighthouse throttling.
&quot;toplevelWarningsMessage&quot;: &quot;A String&quot;, # The label shown preceding important warnings that may have invalidated an entire report.
&quot;varianceDisclaimer&quot;: &quot;A String&quot;, # The disclaimer shown below a performance metric value.
&quot;viewTreemapLabel&quot;: &quot;A String&quot;, # Label for a button that opens the Treemap App
&quot;warningAuditsGroupTitle&quot;: &quot;A String&quot;, # The heading that is shown above a list of audits that have warnings
&quot;warningHeader&quot;: &quot;A String&quot;, # The label shown above a bulleted list of warnings.
},
},
Expand Down

0 comments on commit 47d41c5

Please sign in to comment.