Skip to main content

list_files

List the project's files: stored content (features, generated specs, configs) plus the template scaffolding.

Request

GET /api/v1/ops/projects/{project}/files?prefix=
ParameterInTypeRequiredDescription
projectpathstringyesThe project's public id.
prefixquerystringnoFilter by path prefix, e.g. Configurations/.
curl -H "Authorization: Bearer $TESTVIBE_API_KEY" \
"$TESTVIBE_SERVER/api/v1/ops/projects/$PROJECT/files?prefix=Features/"

Response

[
{
"path": "Features/Login Functionality/login.feature",
"kind": "feature",
"source": "project",
"featureId": 12,
"bytes": 532
},
{
"path": "Features/Login Functionality/login.spec.js",
"kind": "spec",
"source": "project",
"featureId": 12,
"bytes": 4817
},
{
"path": "Configurations/Default.config.js",
"kind": "config",
"source": "template"
}
]

source: "project" entries are stored content (with featureId and bytes); source: "template" entries are the read-only scaffolding a project inherits until it stores its own copy.

Errors

HTTPWhen
404 not_foundNo such project in this workspace.