From 7edc1e18b138ffad79d41e9d5db721714f7c928f Mon Sep 17 00:00:00 2001 From: docubot <67483024+docubot@users.noreply.github.com> Date: Wed, 7 Jun 2023 03:27:13 -0400 Subject: [PATCH] Update OpenAPI Description (#37615) --- src/github-apps/lib/config.json | 2 +- src/rest/data/ghec-2022-11-28/schema.json | 108 +++++++++++++++++++++- src/rest/lib/config.json | 2 +- src/webhooks/lib/config.json | 2 +- 4 files changed, 109 insertions(+), 5 deletions(-) diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 82c5e7ad09..840715e6f5 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -7,5 +7,5 @@ "2022-11-28" ] }, - "sha": "5c1ef48b46e09d15bbc945937e7990af6d99c64b" + "sha": "193ad6ccce0fb307bcfd5c7a656854253c227a45" } \ No newline at end of file diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 07a9497103..5cdcc00229 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -256058,8 +256058,8 @@ "example": { "server_id": "ea6088f3-f095-4bf2-8d7f-c573819e8768", "collection_date": "2021-12-14T23:59:59Z", - "schema_version": "20220111", - "ghes_version": "3.5.0", + "schema_version": "20230306", + "ghes_version": "3.9.0", "host_name": "github.example.com", "github_connect": { "features_enabled": [ @@ -256127,6 +256127,12 @@ "dormant_users": { "total_dormant_users": 5, "dormancy_threshold": "90 days" + }, + "actions_stats": { + "$ref": "server-statistics-actions.yaml" + }, + "packages_stats": { + "$ref": "server-statistics-packages.yaml" } }, "schema": { @@ -256329,6 +256335,104 @@ "type": "string" } } + }, + "actions_stats": { + "type": "object", + "description": "Actions metrics that are included in the Server Statistics payload/export from GHES", + "properties": { + "number_of_repos_using_actions": { + "description": "The total number of repositories in a GHES installation that have Actions enabled", + "type": "integer" + }, + "percentage_of_repos_using_actions": { + "description": "The percentage of repositories in a GHES installation that have Actions enabled", + "type": "string" + } + } + }, + "packages_stats": { + "type": "object", + "description": "Packages metrics that are included in the Server Statistics payload/export from GHES", + "properties": { + "registry_enabled": { + "description": "Whether GitHub Packages is enabled globally in a GHES installation", + "type": "boolean" + }, + "registry_v2_enabled": { + "description": "Whether a beta registry is enabled in a GHES installation", + "type": "boolean" + }, + "ecosystems": { + "description": "The details of the package ecosystems that are enabled in a GHES installation", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "description": "The name of the package ecosystem", + "type": "string", + "enum": [ + "npm", + "maven", + "docker", + "nuget", + "rubygems", + "containers" + ] + }, + "enabled": { + "description": "Shows if a package system is enabled, disabled, or read-only in a GHES installation", + "type": "string", + "enum": [ + "TRUE", + "FALSE", + "READONLY" + ] + }, + "published_packages_count": { + "description": "The total number of published packages in a package ecosystem in a GHES installation", + "type": "integer" + }, + "private_packages_count": { + "description": "The total number of private packages in a package ecosystem in a GHES installation", + "type": "integer" + }, + "public_packages_count": { + "description": "The total number of public packages in a package ecosystem in a GHES installation", + "type": "integer" + }, + "internal_packages_count": { + "description": "The total number of internal packages in a package ecosystem in a GHES installation", + "type": "integer" + }, + "user_packages_count": { + "description": "The total number of user packages in a package ecosystem in a GHES installation", + "type": "integer" + }, + "organization_packages_count": { + "description": "The total number of organization packages in a package ecosystem in a GHES installation", + "type": "integer" + }, + "daily_download_count": { + "description": "The total number of packages in an ecosystem that have been downloaded in the 24 hours prior to `collection_date` for a GHES installation", + "type": "integer" + }, + "daily_update_count": { + "description": "The total number of packages in an ecosystem that have been updated in the 24 hours prior to `collection_date` for a GHES installation", + "type": "integer" + }, + "daily_delete_count": { + "description": "The total number of packages in an ecosystem that have been deleted in the 24 hours prior to `collection_date` for a GHES installation", + "type": "integer" + }, + "daily_create_count": { + "description": "The total number of packages in an ecosystem that have been created in the 24 hours prior to `collection_date` for a GHES installation", + "type": "integer" + } + } + } + } + } } } } diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index df6189efe1..3a0a6c2d8a 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -30,5 +30,5 @@ ] } }, - "sha": "5c1ef48b46e09d15bbc945937e7990af6d99c64b" + "sha": "193ad6ccce0fb307bcfd5c7a656854253c227a45" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 87accc45e7..51e4f9bc1d 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "5c1ef48b46e09d15bbc945937e7990af6d99c64b" + "sha": "193ad6ccce0fb307bcfd5c7a656854253c227a45" } \ No newline at end of file