Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Show relative path examples, because filenames alone won't work #35386

Closed
wants to merge 1 commit into from
Closed

Show relative path examples, because filenames alone won't work #35386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/rest/data/fpt-2022-11-28/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37095,7 +37095,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List all workflow runs for a workflow. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>. You can use parameters to narrow the list of results. For more information about using parameters, see <a href=\"https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</p>\n<p>Anyone with read access to the repository can use this endpoint</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"descriptionHTML": "<p>List all workflow runs for a workflow. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>.github%2Fworkflows%2Fmain.yaml</code>. You can use parameters to narrow the list of results. For more information about using parameters, see <a href=\"https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</p>\n<p>Anyone with read access to the repository can use this endpoint</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down Expand Up @@ -37510,7 +37510,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a specific workflow. You can replace <code>workflow_id</code> with the workflow\nfile name. For example, you could use <code>main.yaml</code>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"descriptionHTML": "<p>Gets a specific workflow. You can replace <code>workflow_id</code> with the workflow\nfile name. For example, you could use <code>.github%2Fworkflows%2Fmain.yaml</code>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down Expand Up @@ -37591,7 +37591,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Disables a workflow and sets the <code>state</code> of the workflow to <code>disabled_manually</code>. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Disables a workflow and sets the <code>state</code> of the workflow to <code>disabled_manually</code>. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>.github%2Fworkflows%2Fmain.yaml</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
Expand Down Expand Up @@ -37694,7 +37694,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>You must configure your GitHub Actions workflow to run when the <a href=\"/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch\"><code>workflow_dispatch</code> webhook</a> event occurs. The <code>inputs</code> are configured in the workflow file. For more information about how to configure the <code>workflow_dispatch</code> event in the workflow file, see \"<a href=\"/actions/reference/events-that-trigger-workflows#workflow_dispatch\">Events that trigger workflows</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>.github%2Fworkflows%2Fmain.yaml</code>.</p>\n<p>You must configure your GitHub Actions workflow to run when the <a href=\"/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch\"><code>workflow_dispatch</code> webhook</a> event occurs. The <code>inputs</code> are configured in the workflow file. For more information about how to configure the <code>workflow_dispatch</code> event in the workflow file, see \"<a href=\"/actions/reference/events-that-trigger-workflows#workflow_dispatch\">Events that trigger workflows</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
Expand Down Expand Up @@ -37775,7 +37775,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Enables a workflow and sets the <code>state</code> of the workflow to <code>active</code>. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Enables a workflow and sets the <code>state</code> of the workflow to <code>active</code>. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>.github%2Fworkflows%2Fmain.yaml</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
Expand Down Expand Up @@ -37910,7 +37910,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"<a href=\"https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions\">Managing billing for GitHub Actions</a>\".</p>\n<p>You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"descriptionHTML": "<p>Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"<a href=\"https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions\">Managing billing for GitHub Actions</a>\".</p>\n<p>You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>.github%2Fworkflows%2Fmain.yaml</code>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down
12 changes: 6 additions & 6 deletions src/rest/data/ghec-2022-11-28/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43473,7 +43473,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List all workflow runs for a workflow. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>. You can use parameters to narrow the list of results. For more information about using parameters, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</p>\n<p>Anyone with read access to the repository can use this endpoint</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"descriptionHTML": "<p>List all workflow runs for a workflow. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>.github%2Fworkflows%2Fmain.yaml</code>. You can use parameters to narrow the list of results. For more information about using parameters, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</p>\n<p>Anyone with read access to the repository can use this endpoint</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down Expand Up @@ -43888,7 +43888,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a specific workflow. You can replace <code>workflow_id</code> with the workflow\nfile name. For example, you could use <code>main.yaml</code>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"descriptionHTML": "<p>Gets a specific workflow. You can replace <code>workflow_id</code> with the workflow\nfile name. For example, you could use <code>.github%2Fworkflows%2Fmain.yaml</code>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down Expand Up @@ -43969,7 +43969,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Disables a workflow and sets the <code>state</code> of the workflow to <code>disabled_manually</code>. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Disables a workflow and sets the <code>state</code> of the workflow to <code>disabled_manually</code>. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>.github%2Fworkflows%2Fmain.yaml</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
Expand Down Expand Up @@ -44072,7 +44072,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>You must configure your GitHub Actions workflow to run when the <a href=\"/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch\"><code>workflow_dispatch</code> webhook</a> event occurs. The <code>inputs</code> are configured in the workflow file. For more information about how to configure the <code>workflow_dispatch</code> event in the workflow file, see \"<a href=\"/actions/reference/events-that-trigger-workflows#workflow_dispatch\">Events that trigger workflows</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>.github%2Fworkflows%2Fmain.yaml</code>.</p>\n<p>You must configure your GitHub Actions workflow to run when the <a href=\"/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch\"><code>workflow_dispatch</code> webhook</a> event occurs. The <code>inputs</code> are configured in the workflow file. For more information about how to configure the <code>workflow_dispatch</code> event in the workflow file, see \"<a href=\"/actions/reference/events-that-trigger-workflows#workflow_dispatch\">Events that trigger workflows</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
Expand Down Expand Up @@ -44153,7 +44153,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Enables a workflow and sets the <code>state</code> of the workflow to <code>active</code>. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Enables a workflow and sets the <code>state</code> of the workflow to <code>active</code>. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>.github%2Fworkflows%2Fmain.yaml</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
Expand Down Expand Up @@ -44288,7 +44288,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions\">Managing billing for GitHub Actions</a>\".</p>\n<p>You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"descriptionHTML": "<p>Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions\">Managing billing for GitHub Actions</a>\".</p>\n<p>You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>.github%2Fworkflows%2Fmain.yaml</code>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down
Loading
Loading