Redocly Scout agent (1.0)

Scout Worker API.

Download OpenAPI description

openapi.json

openapi.yaml

Overview

URL https://github.com/Redocly/redocly

Redocly Support team@redocly.com

License Redocly

Servers

Mock server

https://redocly.com/_mock/docs/realm/scout/agent-api/openapi/

https://redocly.com/{host}/

Health

Operations related to health checks.

Operations

Webhooks

Operations related to incoming git webhooks.

Operations

Create GitHub webhook event

Request

Registers and start process GitHub repository event. For now only push and create pull request events are supported.

Bodyapplication/jsonrequired

One of:

refstringrequired

The full git ref that is pushed. Example: refs/heads/main or refs/tags/v3.14.1.

beforestringrequired

The SHA of the most recent commit on ref before the push.

afterstringrequired

The SHA of the most recent commit on ref after the push.

createdbooleanrequired

Whether this push created the ref.

deletedbooleanrequired

Whether this push deleted the ref.

forcedbooleanrequired

Whether this push is a force push of the ref.

base_refstring or nullrequired

comparestringrequired

URL that shows the changes in this ref update, from the before commit to the after commit. For a newly created ref that is directly based on the default branch, this is the comparison between the head of the default branch and the after commit. Otherwise, this shows all commits until the after commit.

commitsArray of objects(Commit)required

An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.

commits[].idstringrequired

commits[].tree_idstringrequired

commits[].distinctbooleanrequired

Whether this commit is distinct from any that have been pushed before.

commits[].messagestringrequired

The commit message.

commits[].timestampstring(date-time)required

The ISO 8601 timestamp of the commit.

commits[].urlstring(uri)required

URL that points to the commit API resource.

commits[].authorobject(committer)required

Metaproperties for Git author/committer information.

commits[].author.namestringrequired

The git author's name.

commits[].author.emailstring or nullrequired

The git author's email address.

One of:

The git author's email address.

string(email)

The git author's email address.

commits[].author.datestring(date-time)

commits[].author.usernamestring

commits[].committerobject(committer)required

Metaproperties for Git author/committer information.

commits[].committer.namestringrequired

The git author's name.

commits[].committer.emailstring or nullrequired

The git author's email address.

One of:

The git author's email address.

string(email)

The git author's email address.

commits[].committer.datestring(date-time)

commits[].committer.usernamestring

commits[].addedArray of stringsrequired

An array of files added in the commit.

commits[].modifiedArray of stringsrequired

An array of files modified by the commit.

commits[].removedArray of stringsrequired

An array of files removed in the commit.

head_commitCommit (object) or nullrequired

For pushes where after is or points to a commit object, an expanded representation of that commit. For pushes where after refers to an annotated tag object, an expanded representation of the commit pointed to by the annotated tag.

One of:

head_commit.idstringrequired

head_commit.tree_idstringrequired

head_commit.distinctbooleanrequired

Whether this commit is distinct from any that have been pushed before.

head_commit.messagestringrequired

The commit message.

head_commit.timestampstring(date-time)required

The ISO 8601 timestamp of the commit.

head_commit.urlstring(uri)required

URL that points to the commit API resource.

head_commit.authorobject(committer)required

Metaproperties for Git author/committer information.

head_commit.author.namestringrequired

The git author's name.

head_commit.author.emailstring or nullrequired

The git author's email address.

One of:

The git author's email address.

string(email)

The git author's email address.

head_commit.author.datestring(date-time)

head_commit.author.usernamestring

head_commit.committerobject(committer)required

Metaproperties for Git author/committer information.

head_commit.committer.namestringrequired

The git author's name.

head_commit.committer.emailstring or nullrequired

The git author's email address.

One of:

The git author's email address.

string(email)

The git author's email address.

head_commit.committer.datestring(date-time)

head_commit.committer.usernamestring

head_commit.addedArray of stringsrequired

An array of files added in the commit.

head_commit.modifiedArray of stringsrequired

An array of files modified by the commit.

head_commit.removedArray of stringsrequired

An array of files removed in the commit.

repositoryobject(repository)required

A git repository.

repository.idintegerrequired

Unique identifier of the repository.

repository.node_idstringrequired

The GraphQL identifier of the repository.

repository.namestringrequired

The name of the repository.

repository.full_namestringrequired

The full, globally unique, name of the repository.

repository.privatebooleanrequired

Whether the repository is private or public.

repository.ownerobject(user)required

repository.owner.loginstringrequired

repository.owner.idintegerrequired

repository.owner.node_idstringrequired

repository.owner.namestring

repository.owner.emailstring or null

repository.owner.avatar_urlstring(uri)required

repository.owner.gravatar_idstringrequired

repository.owner.urlstring(uri)required

repository.owner.html_urlstring(uri)required

repository.owner.followers_urlstring(uri)required

repository.owner.following_urlstring(uri-template)required

repository.owner.gists_urlstring(uri-template)required

repository.owner.starred_urlstring(uri-template)required

repository.owner.subscriptions_urlstring(uri)required

repository.owner.organizations_urlstring(uri)required

repository.owner.repos_urlstring(uri)required

repository.owner.events_urlstring(uri-template)required

repository.owner.received_events_urlstring(uri)required

repository.owner.typestringrequired

Enum"Bot""User""Organization"

repository.owner.site_adminbooleanrequired

repository.html_urlstring(uri)required

The URL to view the repository on GitHub.com.

repository.descriptionstring or nullrequired

The repository description.

repository.forkbooleanrequired

Whether the repository is a fork.

repository.urlstring(uri)required

The URL to get more information about the repository from the GitHub API.

repository.forks_urlstring(uri)required

The API URL to list the forks of the repository.

repository.keys_urlstring(uri-template)required

A template for the API URL to get information about deploy keys on the repository.

repository.collaborators_urlstring(uri-template)required

A template for the API URL to get information about collaborators of the repository.

repository.teams_urlstring(uri)required

The API URL to list the teams on the repository.

repository.hooks_urlstring(uri)required

The API URL to list the hooks on the repository.

repository.issue_events_urlstring(uri-template)required

A template for the API URL to get information about issue events on the repository.

repository.events_urlstring(uri)required

The API URL to list the events of the repository.

repository.assignees_urlstring(uri-template)required

A template for the API URL to list the available assignees for issues in the repository.

repository.branches_urlstring(uri-template)required

A template for the API URL to get information about branches in the repository.

repository.tags_urlstring(uri)required

The API URL to get information about tags on the repository.

repository.blobs_urlstring(uri-template)required

A template for the API URL to create or retrieve a raw Git blob in the repository.

repository.git_tags_urlstring(uri-template)required

A template for the API URL to get information about Git tags of the repository.

repository.git_refs_urlstring(uri-template)required

A template for the API URL to get information about Git refs of the repository.

repository.trees_urlstring(uri-template)required

A template for the API URL to create or retrieve a raw Git tree of the repository.

repository.statuses_urlstring(uri-template)required

A template for the API URL to get information about statuses of a commit.

repository.languages_urlstring(uri)required

The API URL to get information about the languages of the repository.

repository.stargazers_urlstring(uri)required

The API URL to list the stargazers on the repository.

repository.contributors_urlstring(uri)required

A template for the API URL to list the contributors to the repository.

repository.subscribers_urlstring(uri)required

The API URL to list the subscribers on the repository.

repository.subscription_urlstring(uri)required

The API URL to subscribe to notifications for this repository.

repository.commits_urlstring(uri-template)required

A template for the API URL to get information about commits on the repository.

repository.git_commits_urlstring(uri-template)required

A template for the API URL to get information about Git commits of the repository.

repository.comments_urlstring(uri-template)required

A template for the API URL to get information about comments on the repository.

repository.issue_comment_urlstring(uri-template)required

A template for the API URL to get information about issue comments on the repository.

repository.contents_urlstring(uri-template)required

A template for the API URL to get the contents of the repository.

repository.compare_urlstring(uri-template)required

A template for the API URL to compare two commits or refs.

repository.merges_urlstring(uri)required

The API URL to merge branches in the repository.

repository.archive_urlstring(uri-template)required

A template for the API URL to download the repository as an archive.

repository.downloads_urlstring(uri)required

The API URL to list the downloads on the repository.

repository.issues_urlstring(uri-template)required

A template for the API URL to get information about issues on the repository.

repository.pulls_urlstring(uri-template)required

A template for the API URL to get information about pull requests on the repository.

repository.milestones_urlstring(uri-template)required

A template for the API URL to get information about milestones of the repository.

repository.notifications_urlstring(uri-template)required

A template for the API URL to get information about notifications on the repository.

repository.labels_urlstring(uri-template)required

A template for the API URL to get information about labels of the repository.

repository.releases_urlstring(uri-template)required

A template for the API URL to get information about releases on the repository.

repository.deployments_urlstring(uri)required

The API URL to list the deployments of the repository.

repository.created_atinteger or stringrequired

One of:

integer

repository.updated_atstring(date-time)required

repository.pushed_atinteger or string or nullrequired

One of:

integer

repository.git_urlstring(uri)required

repository.ssh_urlstringrequired

repository.clone_urlstring(uri)required

repository.svn_urlstring(uri)required

repository.homepagestring or nullrequired

repository.sizeintegerrequired

repository.stargazers_countintegerrequired

repository.watchers_countintegerrequired

repository.languagestring or nullrequired

repository.has_issuesbooleanrequired

Whether issues are enabled.

Default true

repository.has_projectsbooleanrequired

Whether projects are enabled.

Default true

repository.has_downloadsbooleanrequired

Whether downloads are enabled.

Default true

repository.has_wikibooleanrequired

Whether the wiki is enabled.

Default true

repository.has_pagesbooleanrequired

repository.forks_countintegerrequired

repository.mirror_urlstring or null(uri)required

repository.archivedbooleanrequired

Whether the repository is archived.

Default false

repository.disabledboolean

Returns whether or not this repository is disabled.

repository.open_issues_countintegerrequired

repository.licenseLicense (object) or nullrequired

One of:

repository.license.keystringrequired

repository.license.namestringrequired

repository.license.spdx_idstringrequired

repository.license.urlstring or null(uri)required

repository.license.node_idstringrequired

repository.forksintegerrequired

repository.open_issuesintegerrequired

repository.watchersintegerrequired

repository.stargazersinteger

repository.default_branchstringrequired

The default branch of the repository.

repository.allow_squash_mergeboolean

Whether to allow squash merges for pull requests.

Default true

repository.allow_merge_commitboolean

Whether to allow merge commits for pull requests.

Default true

repository.allow_rebase_mergeboolean

Whether to allow rebase merges for pull requests.

Default true

repository.allow_auto_mergeboolean

Whether to allow auto-merge for pull requests.

Default false

repository.allow_forkingboolean

Whether to allow private forks.

repository.allow_update_branchboolean

repository.use_squash_pr_title_as_defaultboolean

repository.is_templatebooleanrequired

repository.web_commit_signoff_requiredbooleanrequired

repository.topicsArray of stringsrequired

repository.visibilitystringrequired

Enum"public""private""internal"

repository.delete_branch_on_mergeboolean

Whether to delete head branches when pull requests are merged.

Default false

repository.master_branchstring

repository.permissionsobject

repository.publicboolean

repository.organizationstring

pusherobject(committer)required

Metaproperties for Git author/committer information.

pusher.namestringrequired

The git author's name.