Generated by API Evangelist
Written by API Evangelist tooling for Redocly's API. It is a proposal applied on top of the contract, not a document Redocly publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Redocly Scout Remotes API
version: 1.0.0
extends: openapi/redocly-remotes-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 2
- target: $.paths['/orgs/{orgId}/projects/{projectId}/remotes'].post
update:
x-apievangelist-phrasing:
intent: Create or reuse a remote at a mount path
effect: write
questions:
- How do I connect a Git repository or URL as a remote content source in a Redocly project?
- What happens if a remote already exists at the same mount path with a different type?
- Can a remote auto-sync changes and auto-merge them back?
instructions:
- text: Create a {type} remote mounted at {mountPath} in project {projectId} of org {orgId}.
slots:
type: requestBody.type
mountPath: requestBody.mountPath
projectId: path.projectId
orgId: path.orgId
- text: Add a {type} remote at {mountPath} for project {projectId} in org {orgId} tracking branch {branchName} with auto-sync {autoSync}.
slots:
type: requestBody.type
mountPath: requestBody.mountPath
projectId: path.projectId
orgId: path.orgId
branchName: requestBody.branchName
autoSync: requestBody.autoSync
method: generated
generated: '2026-09-26'
- target: $.paths['/orgs/{orgId}/projects/{projectId}/remotes/{remoteId}/push'].post
update:
x-apievangelist-phrasing:
intent: Push discovered files into a remote as a commit
effect: write
questions:
- Can I upload a set of files to an existing remote with a commit message and author?
- Is it possible to replace every file in a remote rather than adding to what's there?
instructions:
- text: Push files to remote {remoteId} in project {projectId} of org {orgId} with commit {commit} for job {jobId}.
slots:
remoteId: path.remoteId
projectId: path.projectId
orgId: path.orgId
commit: requestBody.commit
jobId: requestBody.jobId
- text: Replace all content in remote {remoteId} (project {projectId}, org {orgId}) with files {files} using commit {commit} for job {jobId}, replace set to {replace}.
slots:
remoteId: path.remoteId
projectId: path.projectId
orgId: path.orgId
files: requestBody.files
commit: requestBody.commit
jobId: requestBody.jobId
replace: requestBody.replace
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.