The unique run ID of the ghe-config-apply run.
Response
", + "example": { + "running": true, + "successful": false, + "nodes": [ + { + "run_id": "d34db33f", + "hostname": "ghes-01.lan", + "running": true, + "successful": false + } + ] + }, + "schema": { + "type": "object", + "properties": { + "running": { + "type": "boolean", + "description": "Whether the ghe-config-apply run is still running in the environment" + }, + "successful": { + "type": "boolean", + "description": "Whether the ghe-config-apply run was successful in the environment" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "run_id": { + "type": "string", + "description": "The unique Run ID of the ghe-config-apply run on the host" + }, + "hostname": { + "type": "string", + "description": "The hostname of the node" + }, + "running": { + "type": "boolean", + "description": "Whether the ghe-config-apply run is still running on the host" + }, + "successful": { + "type": "boolean", + "description": "Whether the ghe-config-apply run was successful on the host" + } + } + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Displays the current status of ghe-config-apply in the environment or the status of a historical run by ID.
OK
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Unauthorized
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME", + "verb": "post", + "requestPath": "/manage/v1/config/apply", + "title": "Trigger a ghe-config-apply run", + "category": "enterprise-admin", + "subcategory": "manage-ghes", + "parameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "run_id", + "in": "body", + "description": "The run ID to execute ghe-config-apply with. If not provided, a run ID will be generated randomly.
Response
", + "example": { + "run_id": "d34db33f" + }, + "schema": { + "type": "object", + "properties": { + "run_id": { + "type": "string", + "description": "Run ID the job was launched with" + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Triggers a run of ghe-config-apply from the ghes-manage agent on your Nomad Delegate instance.\nYou can provide a run ID or allow one to be generated randomly.
OK
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Unauthorized
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME", + "verb": "get", + "requestPath": "/manage/v1/config/apply/events", + "title": "List events from ghe-config-apply", + "category": "enterprise-admin", + "subcategory": "manage-ghes", + "parameters": [ + { + "name": "last_request_id", + "description": "The unique ID of the last response from a host, used for pagination.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "nodes": [ + { + "node": "ghes-01.lan", + "last_request_id": "387cd628c06d606700e79be368e5e574:0cde553750689c76:0000000000000000", + "events": [ + { + "timestamp": "2023-01-01T13:00:00+00:00", + "severity_text": "INFO", + "body": "Validating services", + "event_name": "Enterprise::ConfigApply::PhaseValidation#config_phase_validation", + "topology": "multinode", + "hostname": "ghes-01.lan", + "config_run_id": "d34db33f", + "trace_id": "387cd628c06d606700e79be368e5e574", + "span_id": "0cde553750689c76", + "span_parent_id": 0, + "span_depth": 0 + } + ] + } + ] + }, + "schema": { + "type": "object", + "properties": { + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "node": { + "type": "string", + "description": "Hostname of the node" + }, + "last_request_id": { + "type": "string", + "description": "Unique ID of the last response from a host used for pagination" + }, + "events": { + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { + "type": "string" + }, + "severity_text": { + "type": "string" + }, + "body": { + "type": "string" + }, + "event_name": { + "type": "string" + }, + "topology": { + "type": "string" + }, + "hostname": { + "type": "string" + }, + "config_run_id": { + "type": "string" + }, + "trace_id": { + "type": "string" + }, + "span_id": { + "type": "string" + }, + "span_parent_id": { + "type": "string" + }, + "span_depth": { + "type": "integer" + } + } + } + } + } + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists events from an in-process ghe-config-apply run on your Github Enterprise Server instance.
OK
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Unauthorized
" + } + ] + }, { "serverUrl": "http(s)://HOSTNAME", "verb": "post", @@ -475469,6 +475769,7 @@ ], "description": "The products and respective version ranges affected by the advisory.", "items": { + "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", "type": "object", "properties": { "package": { @@ -475522,7 +475823,7 @@ "string", "null" ], - "description": "The package version that resolve the vulnerability." + "description": "The package version that resolves the vulnerability." }, "vulnerable_functions": { "type": [ @@ -476121,6 +476422,7 @@ ], "description": "The products and respective version ranges affected by the advisory.", "items": { + "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", "type": "object", "properties": { "package": { @@ -476174,7 +476476,7 @@ "string", "null" ], - "description": "The package version that resolve the vulnerability." + "description": "The package version that resolves the vulnerability." }, "vulnerable_functions": { "type": [ diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index aa54b6cac8..23cd4f0e28 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -44,5 +44,5 @@ ] } }, - "sha": "66db9e217a32aaa0721b9c51c371e5a86c3beeb7" + "sha": "766b9223ff249ba0b09a4ebd16c9cabb44cc63a6" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 4e34497498..31c4a6b53b 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "66db9e217a32aaa0721b9c51c371e5a86c3beeb7" + "sha": "766b9223ff249ba0b09a4ebd16c9cabb44cc63a6" } \ No newline at end of file