Harness · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Harness File Store API
16 actions
16 updates
phrasing
extends
openapi/harness-file-store-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Harness's API. It is a proposal applied on top of the contract, not a document Harness publishes.
What the actions change
x-apievangelist-phrasing
Targets 16
$.info
$.paths['/ng/api/file-store'].get
$.paths['/ng/api/file-store'].post
$.paths['/ng/api/file-store/yaml'].post
$.paths['/ng/api/file-store/{identifier}'].get
$.paths['/ng/api/file-store/{identifier}'].put
$.paths['/ng/api/file-store/{identifier}'].delete
$.paths['/ng/api/file-store/files/{identifier}/download'].get
$.paths['/ng/api/file-store/files/createdBy'].get
$.paths['/ng/api/file-store/files/{scopedFilePath}/content'].get
$.paths['/ng/api/file-store/files/content'].post
$.paths['/ng/api/file-store/{identifier}/referenced-by'].get
$.paths['/ng/api/file-store/supported-entity-types'].get
$.paths['/ng/api/file-store/files/filter'].post
$.paths['/ng/api/file-store/folder'].post
$.paths['/ng/api/file-store/yaml/{identifier}'].put
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Harness File Store API
version: 1.0.0
extends: openapi/harness-file-store-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: 15
- target: $.paths['/ng/api/file-store'].get
update:
x-apievangelist-phrasing:
intent: List files and folders in the file store
effect: read
questions:
- What files and folders are in my Harness file store?
- Can I search the file store listing by name and page through it?
instructions:
- text: List files and folders in the file store for project {projectIdentifier}.
slots:
projectIdentifier: query.projectIdentifier
- text: Search the file store listing for {searchTerm}.
slots:
searchTerm: query.searchTerm
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/file-store'].post
update:
x-apievangelist-phrasing:
intent: Create a file or folder with content
effect: write
questions:
- How do I upload a new config file into the file store?
- Can I create a folder inside another folder in the file store?
instructions:
- text: Create a {type} named {name} under folder {parentIdentifier} in the file store.
slots:
type: requestBody.type
name: requestBody.name
parentIdentifier: requestBody.parentIdentifier
- text: Upload file {name} with content {content} into folder {parentIdentifier}.
slots:
name: requestBody.name
content: requestBody.content
parentIdentifier: requestBody.parentIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/file-store/yaml'].post
update:
x-apievangelist-phrasing:
intent: Create file or folder metadata from YAML
effect: write
questions:
- Can I define a file store entry's metadata in YAML instead of a form?
- What does a YAML payload for a new file-store folder look like?
instructions:
- text: 'Create a file store entry from this YAML: {file}.'
slots:
file: requestBody.file
- text: Register folder metadata via YAML {file} in project {projectIdentifier}.
slots:
file: requestBody.file
projectIdentifier: query.projectIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/file-store/{identifier}'].get
update:
x-apievangelist-phrasing:
intent: Get a file or folder's metadata
effect: read
questions:
- What metadata does the file store keep about one file?
- Can I see who last modified a specific file-store entry?
instructions:
- text: Get metadata for file store entry {identifier}.
slots:
identifier: path.identifier
- text: Show the tags and path of file {identifier} in project {projectIdentifier}.
slots:
identifier: path.identifier
projectIdentifier: query.projectIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/file-store/{identifier}'].put
update:
x-apievangelist-phrasing:
intent: Update a file or folder including content
effect: write
questions:
- How do I replace the contents of a file already in the file store?
- Can I move a file to a different parent folder when I update it?
instructions:
- text: Replace the content of file {identifier} with {content}.
slots:
identifier: path.identifier
content: requestBody.content
- text: Rename file store entry {identifier} to {name} under folder {parentIdentifier}.
slots:
identifier: path.identifier
name: requestBody.name
parentIdentifier: requestBody.parentIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/file-store/{identifier}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a file or folder
effect: destructive
questions:
- How do I delete a file from the file store?
- Can I force-delete a file even when pipelines still reference it?
instructions:
- text: Delete file store entry {identifier}.
slots:
identifier: path.identifier
- text: Force-delete folder {identifier} with forceDelete {forceDelete}.
slots:
identifier: path.identifier
forceDelete: query.forceDelete
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/file-store/files/{identifier}/download'].get
update:
x-apievangelist-phrasing:
intent: Download a file from the file store
effect: read
questions:
- How can I download a file I stored in Harness?
- Can I pull the raw file back down by its identifier?
instructions:
- text: Download file {identifier} from the file store.
slots:
identifier: path.identifier
- text: Save a local copy of file store file {identifier}.
slots:
identifier: path.identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/file-store/files/createdBy'].get
update:
x-apievangelist-phrasing:
intent: List users who created files
effect: read
questions:
- Who has created files in our file store?
- Can I get the list of file authors to use as a filter?
instructions:
- text: List the users who created files in the file store.
- text: Show file creators for project {projectIdentifier}.
slots:
projectIdentifier: query.projectIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/file-store/files/{scopedFilePath}/content'].get
update:
x-apievangelist-phrasing:
intent: Read file content by scoped path in the URL
effect: read
questions:
- Can I read a file's contents using its scoped path in the URL?
- How do I fetch the text of an account-scoped file by path?
instructions:
- text: Read the content of scoped file path {scopedFilePath}.
slots:
scopedFilePath: path.scopedFilePath
- text: Show me what's in {scopedFilePath} using the path-in-URL endpoint.
slots:
scopedFilePath: path.scopedFilePath
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/file-store/files/content'].post
update:
x-apievangelist-phrasing:
intent: Read file content by path sent in the body
effect: read
questions:
- Can I get a file's content by posting its path as plain text in the request body?
- Which endpoint returns file content when the path has characters awkward to put in a URL?
instructions:
- text: Fetch file content by posting the scoped path in the body for project {projectIdentifier}.
slots:
projectIdentifier: query.projectIdentifier
- text: Read a file's text using the body-path content endpoint.
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/file-store/{identifier}/referenced-by'].get
update:
x-apievangelist-phrasing:
intent: List entities that reference a file
effect: read
questions:
- Which pipelines or services reference a given file?
- Can I check where a file is used before I delete it?
instructions:
- text: List entities that reference file {identifier}.
slots:
identifier: path.identifier
- text: Show {entityType} entities using file {identifier}.
slots:
entityType: query.entityType
identifier: path.identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/file-store/supported-entity-types'].get
update:
x-apievangelist-phrasing:
intent: List entity types that can reference files
effect: read
questions:
- What kinds of entities can reference a file-store file?
- Which entity types are supported for file references?
instructions:
- text: List supported file reference entity types for account {accountIdentifier}.
slots:
accountIdentifier: query.accountIdentifier
- text: Show which entity types can use stored files.
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/file-store/files/filter'].post
update:
x-apievangelist-phrasing:
intent: Filter files by usage, creator, tags
effect: read
questions:
- Can I find files by their usage type, creator or tags?
- How do I apply a saved filter to the file store?
instructions:
- text: Filter the file store to files with usage {fileUsage}.
slots:
fileUsage: requestBody.fileUsage
- text: Apply saved filter {filterIdentifier} to the file store with filter type {filterType}.
slots:
filterIdentifier: query.filterIdentifier
filterType: requestBody.filterType
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/file-store/folder'].post
update:
x-apievangelist-phrasing:
intent: List a folder's immediate children
effect: read
questions:
- What's directly inside a folder, without walking every subfolder?
- Can I browse the file store one folder level at a time?
instructions:
- text: Show the first-level contents of folder {identifier} named {name}.
slots:
identifier: requestBody.identifier
name: requestBody.name
- text: Expand {type} node {identifier} one level.
slots:
type: requestBody.type
identifier: requestBody.identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/file-store/yaml/{identifier}'].put
update:
x-apievangelist-phrasing:
intent: Update file or folder metadata from YAML
effect: write
questions:
- Can I change a file's name, description or tags using YAML?
- Does the YAML update endpoint change file content or only metadata?
instructions:
- text: Update metadata of file store entry {identifier} from YAML {file}.
slots:
identifier: path.identifier
file: requestBody.file
- text: 'Apply this YAML metadata to folder {identifier}: {file}.'
slots:
identifier: path.identifier
file: requestBody.file
method: generated
generated: '2026-09-26'