{"items":[{"type":"link","fsPath":"docs/realm/scout/index.md","metadata":{"redocly_category":"Realm","type":"markdown"},"label":"Documentation","link":"/docs/realm/scout","routeSlug":"/docs/realm/scout"},{"type":"link","fsPath":"docs/realm/scout/what-is-scout.md","metadata":{"redocly_category":"Realm","type":"markdown"},"label":"What is Scout?","link":"/docs/realm/scout/what-is-scout","routeSlug":"/docs/realm/scout/what-is-scout"},{"type":"link","fsPath":"docs/realm/scout/use-cases.md","metadata":{"redocly_category":"Realm","type":"markdown"},"label":"Use cases","link":"/docs/realm/scout/use-cases","routeSlug":"/docs/realm/scout/use-cases"},{"type":"group","label":"Guides","items":[{"type":"link","fsPath":"docs/realm/scout/guides/install.md","metadata":{"redocly_category":"Realm","type":"markdown"},"label":"Install","link":"/docs/realm/scout/guides/install","routeSlug":"/docs/realm/scout/guides/install"},{"type":"link","fsPath":"docs/realm/scout/guides/api-inventory.md","metadata":{"redocly_category":"Realm","type":"markdown"},"label":"API inventory","link":"/docs/realm/scout/guides/api-inventory","routeSlug":"/docs/realm/scout/guides/api-inventory"},{"type":"link","fsPath":"docs/realm/scout/guides/high-availability.md","metadata":{"redocly_category":"Realm","type":"markdown"},"label":"High availability","link":"/docs/realm/scout/guides/high-availability","routeSlug":"/docs/realm/scout/guides/high-availability"}]},{"type":"group","label":"API reference","items":[{"type":"link","fsPath":"docs/realm/scout/api/filters.md","metadata":{"redocly_category":"Realm","type":"markdown"},"label":"Use filter with collections","link":"/docs/realm/scout/api/filters","routeSlug":"/docs/realm/scout/api/filters"},{"type":"link","label":"Redocly Scout agent","link":"/docs/realm/scout/agent-api/openapi","routeSlug":"/docs/realm/scout/agent-api/openapi"},{"type":"group","label":"Health","link":"/docs/realm/scout/agent-api/openapi/health","routeSlug":"/docs/realm/scout/agent-api/openapi/health","items":[{"label":"Get health status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/scout/agent-api/openapi/health/health","routeSlug":"/docs/realm/scout/agent-api/openapi/health/health","metadata":{"seo":{"title":"Get health status","description":"Get health status"}},"httpPath":"/health"}]},{"type":"group","label":"Webhooks","link":"/docs/realm/scout/agent-api/openapi/webhooks","routeSlug":"/docs/realm/scout/agent-api/openapi/webhooks","items":[{"label":"Create GitHub webhook event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/scout/agent-api/openapi/webhooks/processgithubwebhook","routeSlug":"/docs/realm/scout/agent-api/openapi/webhooks/processgithubwebhook","metadata":{"seo":{"title":"Create GitHub webhook event","description":"Registers and start process GitHub repository event. For now only push and create pull request events are supported."}},"httpPath":"/webhooks/github"},{"label":"Create GitLab webhook event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/scout/agent-api/openapi/webhooks/processgitlabwebhook","routeSlug":"/docs/realm/scout/agent-api/openapi/webhooks/processgitlabwebhook","metadata":{"seo":{"title":"Create GitLab webhook event","description":"Register and start to process GitLab repository event. For now only push and create merge request events are supported."}},"httpPath":"/webhooks/gitlab"}]},{"type":"link","label":"Redocly Scout","link":"/docs/realm/scout/api/openapi","routeSlug":"/docs/realm/scout/api/openapi"},{"type":"group","label":"Remotes","link":"/docs/realm/scout/api/openapi/remotes","routeSlug":"/docs/realm/scout/api/openapi/remotes","items":[{"label":"Upsert remote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/scout/api/openapi/remotes/upsertremote","routeSlug":"/docs/realm/scout/api/openapi/remotes/upsertremote","metadata":{"seo":{"title":"Upsert remote","description":"Upsert remote.If remote with the same mountPath and type already exists the remote object is returned.If the type doesn't match the existing remote, a 409 error is returned.Otherwise, a new remote is created."}},"httpPath":"/orgs/{orgId}/projects/{projectId}/remotes"},{"label":"Push files to remote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/scout/api/openapi/remotes/pushtoremote","routeSlug":"/docs/realm/scout/api/openapi/remotes/pushtoremote","metadata":{"seo":{"title":"Push files to remote","description":"Push discovered files as a remote content.Files should be sent as a multipart/form-data.Commit details like commit message and author can be sent as a JSON object in the commit field."}},"httpPath":"/orgs/{orgId}/projects/{projectId}/remotes/{remoteId}/push"}]},{"type":"group","label":"Metadata","link":"/docs/realm/scout/api/openapi/metadata","routeSlug":"/docs/realm/scout/api/openapi/metadata","items":[{"label":"Get metadata validation result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/scout/api/openapi/metadata/validatemetadata","routeSlug":"/docs/realm/scout/api/openapi/metadata/validatemetadata","metadata":{"seo":{"title":"Get metadata validation result","description":"Validate api metadata against \"metadataSchema\" in project's config file."}},"httpPath":"/orgs/{orgId}/projects/{projectId}/scout/metadata/validate"}]},{"type":"group","label":"Todos","link":"/docs/realm/scout/api/openapi/todos","routeSlug":"/docs/realm/scout/api/openapi/todos","items":[{"label":"Create a job todo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/scout/api/openapi/todos/createtodo","routeSlug":"/docs/realm/scout/api/openapi/todos/createtodo","metadata":{"seo":{"title":"Create a job todo","description":"Git provider webhook triggers Scout to create a job todo. Similarly, a lint job started or completed triggers jobs todo. Since Scout is stateless and distributed, this is the API for storing things to do. It's also a way to communicate with Scout by making jobs for it to do too (such as communicating status back to Git). Finally, it can be used to trigger Scout to update again in the case of a GitHub webhook outage."}},"httpPath":"/orgs/{orgId}/projects/{projectId}/scout/todos"},{"label":"List all todos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/scout/api/openapi/todos/getalltodos","routeSlug":"/docs/realm/scout/api/openapi/todos/getalltodos","metadata":{"seo":{"title":"List all todos","description":"List all todos"}},"httpPath":"/orgs/{orgId}/projects/{projectId}/scout/todos"}]},{"type":"group","label":"Tasks","link":"/docs/realm/scout/api/openapi/tasks","routeSlug":"/docs/realm/scout/api/openapi/tasks","items":[{"label":"Process next job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/scout/api/openapi/tasks/startnextjob","routeSlug":"/docs/realm/scout/api/openapi/tasks/startnextjob","metadata":{"seo":{"title":"Process next job","description":"Retrieve and start the next available job."}},"httpPath":"/orgs/{orgId}/projects/{projectId}/scout/tasks"},{"label":"List all tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/scout/api/openapi/tasks/getalltasks","routeSlug":"/docs/realm/scout/api/openapi/tasks/getalltasks","metadata":{"seo":{"title":"List all tasks","description":"List all tasks"}},"httpPath":"/orgs/{orgId}/projects/{projectId}/scout/tasks"},{"label":"Get task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/scout/api/openapi/tasks/getjobbyid","routeSlug":"/docs/realm/scout/api/openapi/tasks/getjobbyid","metadata":{"seo":{"title":"Get task","description":"Get task."}},"httpPath":"/orgs/{orgId}/projects/{projectId}/scout/tasks/{jobId}"},{"label":"Update job","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/scout/api/openapi/tasks/updatejob","routeSlug":"/docs/realm/scout/api/openapi/tasks/updatejob","metadata":{"seo":{"title":"Update job","description":"Scout sends this API request after completing a job.Supports only PROCESSING -> COMPLETED and PROCESSING -> FAILED transitions."}},"httpPath":"/orgs/{orgId}/projects/{projectId}/scout/tasks/{jobId}"}]},{"type":"group","label":"Status","link":"/docs/realm/scout/api/openapi/status","routeSlug":"/docs/realm/scout/api/openapi/status","items":[{"label":"Push status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/scout/api/openapi/status/reportstatus","routeSlug":"/docs/realm/scout/api/openapi/status/reportstatus","metadata":{"seo":{"title":"Push status","description":"Scout uses this to periodically report it's status back to main api."}},"httpPath":"/orgs/{orgId}/projects/{projectId}/scout/status"}]}]}]}