{"items":[{"type":"link","label":"Redocly Scout","link":"/docs/realm/scout/api/openapi","routeSlug":"/docs/realm/scout/api/openapi","content":{"contentType":"overview","meta":{"name":"Redocly Scout"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/docs/realm/scout/api/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/docs/realm/scout/api/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"API Support","email":"team@redocly.com","label":"team@redocly.com","withCopyButton":true,"copyContent":"team@redocly.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Redocly","url":"https://redocly.com/subscription-agreement"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://redocly.com/subscription-agreement"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","variables":{"host":{"default":"app.cba.au.redocly.com","description":"Server host."}},"description":"Production main server."}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Redocly Scout (1.0)","showPageActions":true}],"sectionId":"/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertRemote","name":"Upsert remote","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert remote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsert remote."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If remote with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mountPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" already exists the remote object is returned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" doesn't match the existing remote, a 409 error is returned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, a new remote is created."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key is required to access the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get your API key from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.blueharvest.cloud"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BlueHarvest dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"UserCookie","scopes":[],"type":"apiKey","in":"cookie","paramName":"accessToken","description":"Default authentication scheme for interaction between browser and API."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_45","description":"Organization ID.","required":true},{"name":"projectId","in":"path","schemaId":"schema_46","description":"Project ID.","required":true}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRemote"}},"schemaId":"components/schemas/CreateRemote","pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orgs/{orgId}/projects/{projectId}/remotes","servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"acme-inc","schemaId":"schema_45"},{"name":"projectId","in":"path","required":true,"example":"my-project","schemaId":"schema_46"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"UserCookie","type":"apiKey","name":"accessToken","in":"cookie"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateRemote"}},"responseCodes":["201","400"],"pointer":"/orgs/{orgId}/projects/{projectId}/remotes","href":"remotes/upsertremote","openApiOperationId":"upsertRemote","summary":"Upsert remote","securityGroups":[{"ApiKey":[]},{"UserCookie":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"schemaId":"components/schemas/CreateRemote","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRemote"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Remote created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Remote"}},"schemaId":"components/schemas/Remote"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Remote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Remote"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remotes/upsertremote"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pushToRemote","name":"Push files to remote","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes~1{remoteId}~1push/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Push files to remote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Push discovered files as a remote content."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files should be sent as a multipart/form-data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commit details like commit message and author can be sent as a JSON object in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key is required to access the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get your API key from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.blueharvest.cloud"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BlueHarvest dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_45","description":"Organization ID.","required":true},{"name":"projectId","in":"path","schemaId":"schema_46","description":"Project ID.","required":true},{"name":"remoteId","in":"path","schemaId":"schema_47","description":"ID of the remote.","required":true}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes~1{remoteId}~1push/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/RemotePush"}},"schemaId":"components/schemas/RemotePush","pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes~1{remoteId}~1push/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orgs/{orgId}/projects/{projectId}/remotes/{remoteId}/push","servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"acme-inc","schemaId":"schema_45"},{"name":"projectId","in":"path","required":true,"example":"my-project","schemaId":"schema_46"},{"name":"remoteId","in":"path","required":true,"example":"rem_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/RemotePush"}},"responseCodes":["200","400","404"],"pointer":"/orgs/{orgId}/projects/{projectId}/remotes/{remoteId}/push","href":"remotes/pushtoremote","openApiOperationId":"pushToRemote","summary":"Push files to remote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"schemaId":"components/schemas/RemotePush","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/RemotePush"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Content pushed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}},"schemaId":"schema_48"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes~1{remoteId}~1push/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_48","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remotes/pushtoremote"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/remotes/{remoteId}/push"}],"content":{"contentType":"group","meta":{"name":"Remotes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remotes","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to remotes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orgs/{orgId}/projects/{projectId}/remotes","summary":"Upsert remote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/remotes/upsertremote","deprecated":false},{"title":"/orgs/{orgId}/projects/{projectId}/remotes/{remoteId}/push","summary":"Push files to remote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/remotes/pushtoremote","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateMetadata","name":"Get metadata validation result","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1metadata~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get metadata validation result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Validate api metadata against \"metadataSchema\" in project's config file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key is required to access the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get your API key from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.blueharvest.cloud"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BlueHarvest dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_45","description":"Organization ID.","required":true},{"name":"projectId","in":"path","schemaId":"schema_46","description":"Project ID.","required":true}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1metadata~1validate/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-scout-version","in":"header","schemaId":"schema_49","description":"Scout version."}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1metadata~1validate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Metadata"}},"schemaId":"components/schemas/Metadata","pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1metadata~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orgs/{orgId}/projects/{projectId}/scout/metadata/validate","servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"acme-inc","schemaId":"schema_45"},{"name":"projectId","in":"path","required":true,"example":"my-project","schemaId":"schema_46"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-scout-version","in":"header","required":false,"example":"1.0.0","schemaId":"schema_49"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Metadata"}},"responseCodes":["200","400","404"],"pointer":"/orgs/{orgId}/projects/{projectId}/scout/metadata/validate","href":"metadata/validatemetadata","openApiOperationId":"validateMetadata","summary":"Get metadata validation result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"schemaId":"components/schemas/Metadata","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Metadata"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataValidationResult"}},"schemaId":"components/schemas/MetadataValidationResult"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1metadata~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MetadataValidationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataValidationResult"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata/validatemetadata"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/scout/metadata/validate"}],"content":{"contentType":"group","meta":{"name":"Metadata"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Metadata","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to metadata."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orgs/{orgId}/projects/{projectId}/scout/metadata/validate","summary":"Get metadata validation result","prefix":{"name":"post","color":"post"},"badges":[],"link":"/metadata/validatemetadata","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTodo","name":"Create a job todo","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1todos/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a job todo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Git provider webhook triggers Scout to create a job todo.\nSimilarly, a lint job started or completed triggers jobs todo.\nSince Scout is stateless and distributed, this is the API for storing things to do.\nIt's also a way to communicate with Scout by making jobs for it to do too (such as communicating status back to Git).\nFinally, it can be used to trigger Scout to update again in the case of a GitHub webhook outage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key is required to access the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get your API key from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.blueharvest.cloud"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BlueHarvest dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_45","description":"Organization ID.","required":true},{"name":"projectId","in":"path","schemaId":"schema_46","description":"Project ID.","required":true}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1todos/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-scout-version","in":"header","schemaId":"schema_49","description":"Scout version."}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1todos/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Job"}},"schemaId":"components/schemas/Job","pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1todos/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orgs/{orgId}/projects/{projectId}/scout/todos","servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"acme-inc","schemaId":"schema_45"},{"name":"projectId","in":"path","required":true,"example":"my-project","schemaId":"schema_46"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-scout-version","in":"header","required":false,"example":"1.0.0","schemaId":"schema_49"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Job"}},"responseCodes":["201","400"],"pointer":"/orgs/{orgId}/projects/{projectId}/scout/todos","href":"todos/createtodo","openApiOperationId":"createTodo","summary":"Create a job todo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"schemaId":"components/schemas/Job","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Job"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}},"schemaId":"components/schemas/Job"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1todos/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Job","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/todos/createtodo"}],"panels":[]}]},"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"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllTodos","name":"List all todos","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1todos/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all todos","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key is required to access the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get your API key from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.blueharvest.cloud"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BlueHarvest dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_45","description":"Organization ID.","required":true},{"name":"projectId","in":"path","schemaId":"schema_46","description":"Project ID.","required":true}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1todos/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_50"},{"name":"before","in":"query","schemaId":"schema_51"},{"name":"sort","in":"query","schemaId":"schema_52"},{"name":"filter","in":"query","schemaId":"schema_53"},{"name":"limit","in":"query","schemaId":"schema_54"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1todos/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-scout-version","in":"header","schemaId":"schema_49","description":"Scout version."}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1todos/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orgs/{orgId}/projects/{projectId}/scout/todos","servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"acme-inc","schemaId":"schema_45"},{"name":"projectId","in":"path","required":true,"example":"my-project","schemaId":"schema_46"}],"query":[{"name":"after","in":"query","required":false,"example":"a25fgaksjf23la==","schemaId":"schema_50"},{"name":"before","in":"query","required":false,"example":"bfg23aksjf23zb1==","schemaId":"schema_51"},{"name":"sort","in":"query","required":false,"schemaId":"schema_52"},{"name":"filter","in":"query","required":false,"example":"status:approved,pending updatedAt:2020-01-01..2022-01-01","schemaId":"schema_53"},{"name":"limit","in":"query","required":false,"schemaId":"schema_54"}],"querystring":[],"header":[{"name":"x-redocly-scout-version","in":"header","required":false,"example":"1.0.0","schemaId":"schema_49"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/orgs/{orgId}/projects/{projectId}/scout/todos","href":"todos/getalltodos","openApiOperationId":"getAllTodos","summary":"List all todos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobList"}},"schemaId":"components/schemas/JobList"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1todos/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobList"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/todos/getalltodos"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/scout/todos"}],"content":{"contentType":"group","meta":{"name":"Todos"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Todos","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to todos."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orgs/{orgId}/projects/{projectId}/scout/todos","summary":"Create a job todo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/todos/createtodo","deprecated":false},{"title":"/orgs/{orgId}/projects/{projectId}/scout/todos","summary":"List all todos","prefix":{"name":"get","color":"get"},"badges":[],"link":"/todos/getalltodos","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startNextJob","name":"Process next job","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Process next job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve and start the next available job."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key is required to access the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get your API key from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.blueharvest.cloud"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BlueHarvest dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_45","description":"Organization ID.","required":true},{"name":"projectId","in":"path","schemaId":"schema_46","description":"Project ID.","required":true}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-scout-version","in":"header","schemaId":"schema_49","description":"Scout version."}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orgs/{orgId}/projects/{projectId}/scout/tasks","servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"acme-inc","schemaId":"schema_45"},{"name":"projectId","in":"path","required":true,"example":"my-project","schemaId":"schema_46"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-scout-version","in":"header","required":false,"example":"1.0.0","schemaId":"schema_49"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","204","400"],"pointer":"/orgs/{orgId}/projects/{projectId}/scout/tasks","href":"tasks/startnextjob","openApiOperationId":"startNextJob","summary":"Process next job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}},"schemaId":"components/schemas/Job"},{"code":"204","description":"No jobs available."},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Job","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/startnextjob"}],"panels":[]}]},"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"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllTasks","name":"List all tasks","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key is required to access the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get your API key from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.blueharvest.cloud"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BlueHarvest dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_45","description":"Organization ID.","required":true},{"name":"projectId","in":"path","schemaId":"schema_46","description":"Project ID.","required":true}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_50"},{"name":"before","in":"query","schemaId":"schema_51"},{"name":"sort","in":"query","schemaId":"schema_52"},{"name":"filter","in":"query","schemaId":"schema_53"},{"name":"limit","in":"query","schemaId":"schema_54"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-scout-version","in":"header","schemaId":"schema_49","description":"Scout version."}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orgs/{orgId}/projects/{projectId}/scout/tasks","servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"acme-inc","schemaId":"schema_45"},{"name":"projectId","in":"path","required":true,"example":"my-project","schemaId":"schema_46"}],"query":[{"name":"after","in":"query","required":false,"example":"a25fgaksjf23la==","schemaId":"schema_50"},{"name":"before","in":"query","required":false,"example":"bfg23aksjf23zb1==","schemaId":"schema_51"},{"name":"sort","in":"query","required":false,"schemaId":"schema_52"},{"name":"filter","in":"query","required":false,"example":"status:approved,pending updatedAt:2020-01-01..2022-01-01","schemaId":"schema_53"},{"name":"limit","in":"query","required":false,"schemaId":"schema_54"}],"querystring":[],"header":[{"name":"x-redocly-scout-version","in":"header","required":false,"example":"1.0.0","schemaId":"schema_49"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/orgs/{orgId}/projects/{projectId}/scout/tasks","href":"tasks/getalltasks","openApiOperationId":"getAllTasks","summary":"List all tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobList"}},"schemaId":"components/schemas/JobList"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobList"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/getalltasks"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJobById","name":"Get task","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get task."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key is required to access the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get your API key from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.blueharvest.cloud"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BlueHarvest dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_45","description":"Organization ID.","required":true},{"name":"projectId","in":"path","schemaId":"schema_46","description":"Project ID.","required":true},{"name":"jobId","in":"path","schemaId":"schema_55","description":"Job ID.","required":true}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks~1{jobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-scout-version","in":"header","schemaId":"schema_49","description":"Scout version."}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orgs/{orgId}/projects/{projectId}/scout/tasks/{jobId}","servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"acme-inc","schemaId":"schema_45"},{"name":"projectId","in":"path","required":true,"example":"my-project","schemaId":"schema_46"},{"name":"jobId","in":"path","required":true,"example":"sjob_01h2t9ksv7vmsvbhh5ty40zctw","schemaId":"schema_55"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-scout-version","in":"header","required":false,"example":"1.0.0","schemaId":"schema_49"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/orgs/{orgId}/projects/{projectId}/scout/tasks/{jobId}","href":"tasks/getjobbyid","openApiOperationId":"getJobById","summary":"Get task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}},"schemaId":"components/schemas/Job"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Job","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/getjobbyid"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateJob","name":"Update job","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks~1{jobId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scout sends this API request after completing a job."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transitions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key is required to access the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get your API key from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.blueharvest.cloud"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BlueHarvest dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_45","description":"Organization ID.","required":true},{"name":"projectId","in":"path","schemaId":"schema_46","description":"Project ID.","required":true},{"name":"jobId","in":"path","schemaId":"schema_55","description":"Job ID.","required":true}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks~1{jobId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-scout-version","in":"header","schemaId":"schema_49","description":"Scout version."}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks~1{jobId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchJob"}},"schemaId":"components/schemas/PatchJob","pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks~1{jobId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/orgs/{orgId}/projects/{projectId}/scout/tasks/{jobId}","servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"acme-inc","schemaId":"schema_45"},{"name":"projectId","in":"path","required":true,"example":"my-project","schemaId":"schema_46"},{"name":"jobId","in":"path","required":true,"example":"sjob_01h2t9ksv7vmsvbhh5ty40zctw","schemaId":"schema_55"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-scout-version","in":"header","required":false,"example":"1.0.0","schemaId":"schema_49"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchJob"}},"responseCodes":["200","400","404"],"pointer":"/orgs/{orgId}/projects/{projectId}/scout/tasks/{jobId}","href":"tasks/updatejob","openApiOperationId":"updateJob","summary":"Update job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"schemaId":"components/schemas/PatchJob","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchJob"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}},"schemaId":"components/schemas/Job"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1tasks~1{jobId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Job","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/updatejob"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/scout/tasks/{jobId}"}],"content":{"contentType":"group","meta":{"name":"Tasks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tasks","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to tasks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orgs/{orgId}/projects/{projectId}/scout/tasks","summary":"Process next job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/startnextjob","deprecated":false},{"title":"/orgs/{orgId}/projects/{projectId}/scout/tasks","summary":"List all tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/getalltasks","deprecated":false},{"title":"/orgs/{orgId}/projects/{projectId}/scout/tasks/{jobId}","summary":"Get task","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/getjobbyid","deprecated":false},{"title":"/orgs/{orgId}/projects/{projectId}/scout/tasks/{jobId}","summary":"Update job","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/tasks/updatejob","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reportStatus","name":"Push status","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Push status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Scout uses this to periodically report it's status back to main api."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key is required to access the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get your API key from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.blueharvest.cloud"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BlueHarvest dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_45","description":"Organization ID.","required":true},{"name":"projectId","in":"path","schemaId":"schema_46","description":"Project ID.","required":true}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1status/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-scout-version","in":"header","schemaId":"schema_49","description":"Scout version."}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Status"}},"schemaId":"components/schemas/Status","pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orgs/{orgId}/projects/{projectId}/scout/status","servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"acme-inc","schemaId":"schema_45"},{"name":"projectId","in":"path","required":true,"example":"my-project","schemaId":"schema_46"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-scout-version","in":"header","required":false,"example":"1.0.0","schemaId":"schema_49"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Status"}},"responseCodes":["204","400"],"pointer":"/orgs/{orgId}/projects/{projectId}/scout/status","href":"status/reportstatus","openApiOperationId":"reportStatus","summary":"Push status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/realm/scout/api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com"}}}],"schemaId":"components/schemas/Status","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Status"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No content."},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1scout~1status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/reportstatus"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/scout/status"}],"content":{"contentType":"group","meta":{"name":"Status"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Status","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to status."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orgs/{orgId}/projects/{projectId}/scout/status","summary":"Push status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/status/reportstatus","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/GitProviderType":{"id":"components/schemas/GitProviderType","kind":"json-schema","title":"GitProviderType","data":{"type":"string","format":"enum","description":"Git provider type.","enum":["GITHUB_CLOUD","GITHUB_SERVER","GITLAB_CLOUD","GITLAB_SELF_MANAGED","BITBUCKET_CLOUD","BITBUCKET_DATACENTER","AZURE"]}},"components/schemas/CreateRemote":{"id":"components/schemas/CreateRemote","kind":"json-schema","title":"CreateRemote","data":{"type":"object","required":["mountPath","type"],"properties":{"mountPath":{"type":"string","description":"Remote target path.","example":"apis/test/@v1"},"type":{"type":"string","description":"Remote type. TODO: Add discriminator by type and add other fields for GIT and URL remote types.","enum":["CICD","GIT","URL"],"example":"CICD"},"autoSync":{"type":"boolean","description":"Auto sync changes to remote."},"autoMerge":{"type":"boolean","description":"Auto merge changes from remote."},"createdAt":{"type":"string","readOnly":true,"examples":["2023-06-07T00:00:00Z"],"format":"date-time"},"updatedAt":{"type":"string","readOnly":true,"examples":["2023-06-07T00:00:00Z"],"format":"date-time"},"providerType":{"$ref":"#/components/schemas/GitProviderType"},"namespaceId":{"type":"string","readOnly":true},"repositoryId":{"type":"string","readOnly":true},"projectId":{"readOnly":true,"type":["string","null"]},"mountBranchName":{"type":"string","readOnly":true},"contentPath":{"type":"string","readOnly":true},"credentialId":{"type":"string","readOnly":true},"branchName":{"type":"string","readOnly":true},"contentType":{"type":"string","readOnly":true,"enum":["FOLDER","FILE"],"example":"FILE"}}}},"components/schemas/Remote":{"id":"components/schemas/Remote","kind":"json-schema","title":"Remote","data":{"allOf":[{"$ref":"#/components/schemas/CreateRemote"},{"type":"object","properties":{"id":{"type":"string","description":"Remote ID.","example":"rem_01h2captefvs9bpg3v6twqqj9n","readOnly":true}},"required":["id"]}]}},"components/schemas/Problem":{"id":"components/schemas/Problem","kind":"json-schema","title":"Problem","data":{"type":"object","title":"Problem","properties":{"type":{"type":"string","format":"uri-reference","description":"URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC 9457 (formerly RFC 7807), it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.\n","default":"about:blank","example":"/some/uri-reference"},"title":{"type":"string","description":"Short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.\n","example":"some title for the error situation"},"status":{"type":"integer","format":"int32","description":"HTTP status code generated by the origin server for this occurrence of the problem.\n","minimum":100,"exclusiveMaximum":600,"example":400},"detail":{"type":"string","description":"Human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.\n","example":"some description for the error situation"},"instance":{"type":"string","format":"uri-reference","description":"URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.\n","example":"/some/uri-reference#specific-occurrence-context"},"object":{"type":"string","const":"problem"}},"required":["type","title","status","object"]}},"components/schemas/RemotePush":{"id":"components/schemas/RemotePush","kind":"json-schema","title":"RemotePush","data":{"type":"object","required":["commit","jobId"],"properties":{"commit":{"type":"object","description":"Commit details.","required":["message","author"],"properties":{"namespace":{"type":"string","description":"Git repo namespace (organization login for GitHub).","example":"Redocly"},"repository":{"type":"string","description":"Git repo name.","example":"redoc"},"message":{"type":"string","description":"Commit message.","example":"chore: Add new API"},"author":{"type":"object","required":["email","name"],"properties":{"name":{"description":"Commit author name.","example":"John Doe"},"email":{"type":"string","description":"Commit author email.","format":"email","example":"johndoe@example.com"},"image":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commit author image URL."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, the default image is used."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the image may not accessible, "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data url"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used."},"children":[]}]}]}]}}}}},"jobId":{"type":"string","format":"ulid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESS_GIT_REPO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" job, if any."},"children":[]}]}]}],"example":"job_01f1q3q1q1q1q1q1q1q1q1q1q1"},"replace":{"type":"boolean","description":"Whether to replace the existing files.\nIf provided, all files from the remote are removed and the new files are added.\nIf not provided, the existing files are kept and the new files are added, overwriting the existing files where they overlap.","example":true,"default":false},"files":{"type":"object","description":"Map of files to upload.","additionalProperties":{"description":"Files to push.","type":"string","format":"binary"}}}}},"components/schemas/PullRequest":{"id":"components/schemas/PullRequest","kind":"json-schema","title":"PullRequest","data":{"type":"object","properties":{"id":{"type":"string","format":"ulid","example":"pr_01h1s5z6vf2mm1mz3hevnn9va7","description":"Pull request Id.","readOnly":true},"number":{"description":"Pull request number.","type":"integer","example":1,"readOnly":true},"branchName":{"description":"Branch name.","type":"string","example":"main","maxLength":512},"title":{"description":"PR title.","type":"string","maxLength":512},"description":{"description":"PR description.","type":"string"},"status":{"description":"PR status.","type":"string","default":"OPEN","enum":["OPEN","CLOSED","MERGED"]},"isDraft":{"description":"Indicates whether or not the pull request is a draft.","type":"boolean"},"reviewers":{"description":"List of reviewers.","type":"array","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"ulid","example":"usr_01h1s5z6vf2mm1mz3hevnn9va7","description":"User id.","readOnly":true},"firstName":{"description":"User first name.","type":"string","readOnly":true},"lastName":{"description":"User last name.","type":"string","readOnly":true}},"required":["id","firstName","lastName"]},"default":[]},"createdBy":{"description":"User who create PR.","type":"object","readOnly":true,"properties":{"id":{"type":"string","format":"ulid","example":"usr_01h1s5z6vf2mm1mz3hevnn9va7","description":"User id.","readOnly":true},"firstName":{"description":"User first name.","type":"string","readOnly":true},"lastName":{"description":"User last name.","type":"string","readOnly":true}},"required":["id","firstName","lastName"]},"closedById":{"type":"string","format":"ulid","example":"usr_01h1s5z6vf2mm1mz3hevnn9va7","description":"User id who close PR.","readOnly":true},"mergedById":{"type":"string","format":"ulid","example":"usr_01h1s5z6vf2mm1mz3hevnn9va7","description":"User id who merged PR.","readOnly":true},"organizationId":{"description":"Organization ID.","type":"string","readOnly":true},"organization":{"description":"Organization.","properties":{"name":{"description":"Organization name.","type":"string"}}},"projectId":{"description":"Project ID.","type":"string","readOnly":true},"project":{"description":"Project.","type":"object","properties":{"name":{"description":"Project name.","type":"string"}}},"reviews":{"description":"list of reviews.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"ulid","example":"rev_01h1s5z6vf2mm1mz3hevnn9va7"},"status":{"type":"string","enum":["APPROVED","REQUESTED_CHANGES","COMMENTED"]},"userId":{"type":"string","format":"ulid","example":"usr_01h1s5z6vf2mm1mz3hevnn9va7"},"user":{"type":"object","properties":{"id":{"type":"string","format":"ulid","example":"usr_01h1s5z6vf2mm1mz3hevnn9va7","description":"User id."},"firstName":{"description":"User first name.","type":"string"},"lastName":{"description":"User last name.","type":"string"}}}}}},"createdAt":{"description":"Created date.","type":"string","readOnly":true,"format":"date-time"},"updatedAt":{"description":"Updated date.","type":"string","readOnly":true,"format":"date-time"}},"required":["id","number","branchName","commitHash","title","status","reviewers","createdAt","updatedAt","createdBy","organizationId","projectId"]}},"components/schemas/Page":{"id":"components/schemas/Page","kind":"json-schema","title":"Page","data":{"type":"object","properties":{"endCursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to load the next page of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", there is no data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor is opaque and internal structure is subject to change."},"children":[]}]}]}]},"startCursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to load the previous page of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", there is no data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor is opaque and internal structure is subject to change."},"children":[]}]}]}]},"hasNextPage":{"type":"boolean","description":"Indicates if there is a next page with items."},"hasPrevPage":{"type":"boolean","description":"Indicates if there is a previous page with items."},"limit":{"type":"integer","minimum":1,"maximum":100,"default":10,"description":"Value showing how many items are in the page limit."},"total":{"type":"integer","description":"Count of items across all pages.","minimum":0}},"required":["endCursor","startCursor","hasNextPage","hasPrevPage","limit","total"]}},"components/schemas/GitCommitCheck":{"id":"components/schemas/GitCommitCheck","kind":"json-schema","title":"GitCommitCheck","data":{"type":"object","properties":{"name":{"type":"string","description":"Check name.","example":"Scorecard - Compliance API"},"status":{"type":"string","enum":["IN_PROGRESS","SUCCESS","FAILED"],"description":"Git commit status."},"description":{"type":"string","description":"Git commit status description."},"targetUrl":{"type":"string","description":"Git commit status target URL."}},"required":["name","status"]}},"components/schemas/JobMetadata":{"id":"components/schemas/JobMetadata","kind":"json-schema","title":"JobMetadata","data":{"type":"object","description":"Additional information about job.","properties":{"scoutVersion":{"type":"string","description":"Scout version.","example":"1.0.0","readOnly":true},"errorMessage":{"type":"string","description":"Error message, if any."},"errorStack":{"type":"string","description":"Error stack trace, if any."}}}},"components/schemas/Job":{"id":"components/schemas/Job","kind":"json-schema","title":"Job","data":{"type":"object","properties":{"id":{"type":"string","format":"ulid","description":"ID of the job.","readOnly":true,"example":"sjob_01h2t9ksv7vmsvbhh5ty40zctw"},"status":{"readOnly":true,"type":"string","enum":["PENDING","PROCESSING","COMPLETED","FAILED"],"description":"Job status."},"type":{"type":"string","enum":["PROCESS_GIT_REPO","UPDATE_STATUS"],"description":"Type of job."},"organizationId":{"description":"Organization ID.","type":"string","readOnly":true},"projectId":{"description":"Project ID.","type":"string","readOnly":true},"providerId":{"description":"Git provider identifier (appId for GitHub).","type":"string"},"providerType":{"type":"string","enum":["GITHUB_CLOUD","GITHUB_SERVER","GITLAB_CLOUD","GITLAB_SELF_MANAGED","BITBUCKET_CLOUD","BITBUCKET_DATACENTER","AZURE"],"description":"Git provider type."},"namespaceId":{"type":"string","description":"Git repo namespace id (organization login for GitHub)."},"repositoryId":{"type":"string","description":"Git repo id."},"branch":{"type":"string","description":"Git branch name."},"commitSha":{"type":"string","description":"Git commit SHA."},"isMainBranch":{"type":"boolean","default":false,"description":"True if branch is main."},"prId":{"type":"string","description":"Git pull request ID."},"attempts":{"type":"integer","description":"Number of attempts to process the job.","readOnly":true},"parentJobId":{"type":"string","description":"ID of the parent job, if any.","format":"ulid","example":"sjob_01h2t9ksv7vmsvbhh5ty40zctw"},"checks":{"type":"array","description":"Commit status checks.","items":{"$ref":"#/components/schemas/GitCommitCheck"}},"metadata":{"$ref":"#/components/schemas/JobMetadata"},"startedAt":{"type":"string","format":"date-time","description":"Job start date.","readOnly":true},"createdAt":{"type":"string","format":"date-time","description":"Job creation date.","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Job last update date.","readOnly":true}},"required":["id","status","type","organizationId","projectId","providerType","namespaceId","repositoryId","branch","commitSha","attempts","createdAt","updatedAt"]}},"components/schemas/JobList":{"id":"components/schemas/JobList","kind":"json-schema","title":"JobList","data":{"type":"object","properties":{"object":{"type":"string","const":"list"},"page":{"$ref":"#/components/schemas/Page"},"items":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/Job"}}},"required":["object","page","items"]}},"components/schemas/PatchJob":{"id":"components/schemas/PatchJob","kind":"json-schema","title":"PatchJob","data":{"type":"object","properties":{"status":{"type":"string","enum":["COMPLETED","FAILED"],"description":"Job status."},"metadata":{"$ref":"#/components/schemas/JobMetadata"}},"required":["status"]}},"components/schemas/Status":{"id":"components/schemas/Status","kind":"json-schema","title":"Status","data":{"type":"object","properties":{"hostname":{"type":"string","description":"Hostname of Scout instance."},"pid":{"type":"integer","description":"Process ID."},"version":{"type":"string","description":"Scout version."},"disk":{"type":"object","description":"Disk usage.","properties":{"size":{"type":"integer","description":"Total disk size."},"used":{"type":"integer","description":"Used disk size."},"available":{"type":"integer","description":"Available disk size."},"unit":{"type":"string","description":"Disk size unit.","enum":["B","KB","MB","GB","TB"],"example":"MB"}},"required":["size","used","available","unit"]},"jobs":{"type":"object","description":"Scout jobs.","properties":{"active":{"type":"integer","description":"Number of active jobs."},"max":{"type":"integer","description":"Maximum number of jobs."}},"required":["active","max"]}},"required":["hostname","pid","version","disk","jobs"]}},"components/schemas/Metadata":{"id":"components/schemas/Metadata","kind":"json-schema","title":"Metadata","data":{"type":"object","description":"Any object shape.","example":{"department":"IT"}}},"components/schemas/MetadataValidationResult":{"id":"components/schemas/MetadataValidationResult","kind":"json-schema","title":"MetadataValidationResult","data":{"type":"object","properties":{"isValid":{"type":"boolean","example":false},"errors":{"type":"array","items":{"type":"object","properties":{"keyword":{"type":"string","description":"Validation keyword."},"instancePath":{"type":"string","description":"JSON Pointer to the location in the data instance.","example":"/prop/1/subProp"},"schemaPath":{"type":"string","description":"JSON Pointer to the location of the failing keyword in the schema."},"params":{"type":"object","description":"Additional information about error.","example":{"missingProperty":"owner"}},"propertyName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set for errors in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyNames"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keyword schema."},"children":[]}]}]}]},"message":{"type":"string","description":"Error message."},"schema":{"description":"Value of the failing keyword in the schema."},"parentSchema":{"type":"object","description":"Schema containing the keyword."},"data":{"description":"Data validated by the keyword."}},"required":["keyword","instancePath","schemaPath","params"],"example":{"instancePath":"","schemaPath":"#/required","keyword":"required","params":{"missingProperty":"owner"},"message":"must have required property 'owner'"}},"description":"Array of metadata validation errors."}},"required":["isValid"]}},"schema_45":{"kind":"json-schema","data":{"type":"string","example":"acme-inc"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"string","example":"my-project"},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"string","format":"ulid","example":"rem_01h1s5z6vf2mm1mz3hevnn9va7"},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/PullRequest"},{"type":"object","required":["branchName","hasChanges"],"properties":{"branchName":{"type":"string"},"hasChanges":{"type":"boolean"}}}]},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"string","example":"1.0.0"},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endCursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to get the next page."},"children":[]}]}]}],"example":"a25fgaksjf23la=="},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startCursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to get the next page."},"children":[]}]}]}],"example":"bfg23aksjf23zb1=="},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This list is currently not sortable by other properties."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is sorted by the id descending ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") by default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To reverse the sort order, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the value."},"children":[]}]}]}],"type":"string","default":"-id"},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the collection items. This field requires a special format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Using-filter-with-collections"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using filter with collections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"status:approved,pending updatedAt:2020-01-01..2022-01-01"},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use to return a number of results per page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there is more data, use in combination with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to page through the data."},"children":[]}]}]}],"type":"integer","minimum":1,"maximum":100,"default":10},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"string","format":"ulid","example":"sjob_01h2t9ksv7vmsvbhh5ty40zctw"},"id":"schema_55"}},"exampleStore":{},"securitySchemeStore":{"UserCookie":{"id":"UserCookie","type":"apiKey","description":"Default authentication scheme for interaction between browser and API.","in":"cookie","paramName":"accessToken"},"ApiKey":{"id":"ApiKey","type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key is required to access the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get your API key from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.blueharvest.cloud"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BlueHarvest dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"servers":[{"url":"/_mock/docs/realm/scout/api/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://{host}/api","description":"Production main server.","variables":{"host":{"default":"app.cba.au.redocly.com","description":"Server host."}}}]},"options":{"excludeFromSearch":true,"feedback":{"type":"sentiment","settings":{"comment":{"likeLabel":"What was most helpful?","dislikeLabel":"What can we improve?"},"label":"Was this section helpful?"}},"hideSidebar":true,"mockServer":{"url":"/_mock/docs/realm/scout/api/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/realm/scout/api/openapi.json?download"},{"url":"/_bundle/docs/realm/scout/api/openapi.yaml?download"}],"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Redocly Scout"}},"baseSlug":"/docs/realm/scout/api/openapi","routesMapping":{}}