Skip to content

Redocly Scout (1.0)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
API Support
team@redocly.com
License
Redocly
Terms of Service
Languages
Servers
Mock server
https://redocly.com/_mock/docs/realm/scout/api/openapi/
Production main server.
https://{host}/api/

Remotes

Operations related to remotes.

Operations

Upsert remote

Request

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.

Security
ApiKey or UserCookie
Path
orgIdstringrequired

Organization ID.

Example: acme-inc
projectIdstringrequired

Project ID.

Example: my-project
Bodyapplication/json
mountPathstringrequired

Remote target path.

Example: "apis/test/@v1"
typestringrequired

Remote type. TODO: Add discriminator by type and add other fields for GIT and URL remote types.

Enum"CICD""GIT""URL"
Example: "CICD"
autoSyncboolean

Auto sync changes to remote.

autoMergeboolean

Auto merge changes from remote.

providerTypestring(enum)(GitProviderType)
Enum"GITHUB_CLOUD""GITHUB_SERVER""GITLAB_CLOUD""GITLAB_SELF_MANAGED""BITBUCKET_CLOUD""BITBUCKET_DATACENTER""AZURE"
curl -i -X POST \
  https://redocly.com/_mock/docs/realm/scout/api/openapi/orgs/acme-inc/projects/my-project/remotes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "mountPath": "apis/test/@v1",
    "type": "CICD",
    "autoSync": true,
    "autoMerge": true,
    "providerType": "GITHUB_CLOUD"
  }'

Responses

Remote created.

Bodyapplication/json
mountPathstringrequired

Remote target path.

Example: "apis/test/@v1"
typestringrequired

Remote type. TODO: Add discriminator by type and add other fields for GIT and URL remote types.

Enum"CICD""GIT""URL"
Example: "CICD"
autoSyncboolean

Auto sync changes to remote.

autoMergeboolean

Auto merge changes from remote.

createdAtstring(date-time)read-only
updatedAtstring(date-time)read-only
providerTypestring(enum)(GitProviderType)
Enum"GITHUB_CLOUD""GITHUB_SERVER""GITLAB_CLOUD""GITLAB_SELF_MANAGED""BITBUCKET_CLOUD""BITBUCKET_DATACENTER""AZURE"
namespaceIdstringread-only
repositoryIdstringread-only
projectIdstring or nullread-only
mountBranchNamestringread-only
contentPathstringread-only
credentialIdstringread-only
branchNamestringread-only
contentTypestringread-only
Enum"FOLDER""FILE"
Example: "FILE"
idstringread-onlyrequired

Remote ID.

Example: "rem_01h2captefvs9bpg3v6twqqj9n"
Response
application/json
{
  "mountPath": "apis/test/@v1",
  "type": "CICD",
  "autoSync": true,
  "autoMerge": true,
  "createdAt": "2023-06-07T00:00:00Z",
  "updatedAt": "2023-06-07T00:00:00Z",
  "providerType": "GITHUB_CLOUD",
  "namespaceId": "string",
  "repositoryId": "string",
  "projectId": "string",
  "mountBranchName": "string",
  "contentPath": "string",
  "credentialId": "string",
  "branchName": "string",
  "contentType": "FILE",
  "id": "rem_01h2captefvs9bpg3v6twqqj9n"
}

Push files to remote

Request

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.

Security
ApiKey
Path
orgIdstringrequired

Organization ID.

Example: acme-inc
projectIdstringrequired

Project ID.

Example: my-project
remoteIdstring(ulid)required

ID of the remote.

Example: rem_01h1s5z6vf2mm1mz3hevnn9va7
Bodymultipart/form-data
commitobjectrequired

Commit details.

commit.​namespacestring

Git repo namespace (organization login for GitHub).

Example: "Redocly"
commit.​repositorystring

Git repo name.

Example: "redoc"
commit.​messagestringrequired

Commit message.

Example: "chore: Add new API"
commit.​authorobjectrequired
commit.​author.​nameanyrequired

Commit author name.

Example: "John Doe"
commit.​author.​emailstring(email)required

Commit author email.

Example: "johndoe@example.com"
commit.​author.​imagestring

Commit author image URL. If not provided, the default image is used. If the image may not accessible, data url can be used.

jobIdstring(ulid)required

ID of the PROCESS_GIT_REPO job, if any.

Example: "job_01f1q3q1q1q1q1q1q1q1q1q1q1"
replaceboolean

Whether to replace the existing files. If provided, all files from the remote are removed and the new files are added. If not provided, the existing files are kept and the new files are added, overwriting the existing files where they overlap.

Default false
Example: true
filesobject

Map of files to upload.

curl -i -X POST \
  https://redocly.com/_mock/docs/realm/scout/api/openapi/orgs/acme-inc/projects/my-project/remotes/rem_01h1s5z6vf2mm1mz3hevnn9va7/push \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'commit[namespace]=Redocly' \
  -F 'commit[repository]=redoc' \
  -F 'commit[message]=chore: Add new API' \
  -F 'commit[author][name]=John Doe' \
  -F 'commit[author][email]=johndoe@example.com' \
  -F 'commit[author][image]=string' \
  -F jobId=job_01f1q3q1q1q1q1q1q1q1q1q1q1 \
  -F replace=true \
  -F 'files[property1]=string' \
  -F 'files[property2]=string'

Responses

Content pushed.

Bodyapplication/json
One of:
object PullRequest Recursive
Response
application/json
{
  "id": "pr_01h1s5z6vf2mm1mz3hevnn9va7",
  "number": 1,
  "branchName": "main",
  "title": "string",
  "description": "string",
  "status": "OPEN",
  "isDraft": true,
  "reviewers": [],
  "createdBy": {
    "id": "usr_01h1s5z6vf2mm1mz3hevnn9va7",
    "firstName": "string",
    "lastName": "string"
  },
  "closedById": "usr_01h1s5z6vf2mm1mz3hevnn9va7",
  "mergedById": "usr_01h1s5z6vf2mm1mz3hevnn9va7",
  "organizationId": "string",
  "organization": {
    "name": "string"
  },
  "projectId": "string",
  "project": {
    "name": "string"
  },
  "reviews": [
    { … }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Metadata

Operations related to metadata.

Operations

Todos

Operations related to todos.

Operations

Tasks

Operations related to tasks.

Operations

Status

Operations related to status.

Operations