Operations related to remotes.
Remote type. TODO: Add discriminator by type and add other fields for GIT and URL remote types.
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"
}'
Remote created.
Remote type. TODO: Add discriminator by type and add other fields for GIT and URL remote types.
Git provider type.
{ "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" }
Commit details.
Commit author image URL. If not provided, the default image is used. If the image may not accessible, data url can be used.
ID of the PROCESS_GIT_REPO
job, if any.
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.
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'
{ "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" }