Skip to content

Commit

Permalink
Merge pull request #131 from mkusaka/update-20240106T000247
Browse files Browse the repository at this point in the history
update 20240106T000247
  • Loading branch information
mkusaka authored Jan 6, 2024
2 parents 232368c + c2f3ac2 commit ad460a3
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -1035,7 +1035,7 @@
},
"/insights/pages/{project-slug}/summary": {
"get": {
"description": "Get summary metrics and trends for a project at workflow and branch level. \n Workflow runs going back at most 90 days are included in the aggregation window. \n Trends are only supported upto last 30 days. \n Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI.",
"description": "Get summary metrics and trends for a project at workflow and branch level.\n Workflow runs going back at most 90 days are included in the aggregation window.\n Trends are only supported upto last 30 days.\n Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI.",
"operationId": "getProjectWorkflowsPageData",
"parameters": [
{
Expand Down Expand Up @@ -1078,7 +1078,7 @@
},
{
"description": "The names of workflows to include in workflow-level metrics.",
"example": "A single workflow name: ?workflow-names=build-test-deploy or \n for multiple workflow names: ?workflow-names=build&workflow-names=test-and-deploy.",
"example": "A single workflow name: ?workflow-names=build-test-deploy or\n for multiple workflow names: ?workflow-names=build&workflow-names=test-and-deploy.",
"in": "query",
"name": "workflow-names",
"required": false,
Expand Down Expand Up @@ -1644,7 +1644,7 @@
},
"/insights/{org-slug}/summary": {
"get": {
"description": "Gets aggregated summary metrics with trends for the entire org. \n Also gets aggregated metrics and trends for each project belonging to the org.",
"description": "Gets aggregated summary metrics with trends for the entire org.\n Also gets aggregated metrics and trends for each project belonging to the org.",
"operationId": "getOrgSummaryData",
"parameters": [
{
Expand Down Expand Up @@ -1952,7 +1952,7 @@
},
"/insights/{project-slug}/flaky-tests": {
"get": {
"description": "Get a list of flaky tests for a given project. Flaky tests are branch agnostic. \n A flaky test is a test that passed and failed in the same commit.",
"description": "Get a list of flaky tests for a given project. Flaky tests are branch agnostic.\n A flaky test is a test that passed and failed in the same commit.",
"operationId": "getFlakyTests",
"parameters": [
{
Expand Down

0 comments on commit ad460a3

Please sign in to comment.