Skip to main content

Project repository sources

Generated from apiome-rest/openapi.yaml (API version 1.307.0) — do not edit by hand. How to authenticate is on the REST API reference.

Tag: project-repository-sources · 1 operation

GET /v1/tenants/{tenant_slug}/projects/{project_ref}/repository-sources​

List a project's contributing repositories and per-entity provenance

The repository files whose imports make up the project's merged API surface, in precedence order (1 contributed first), and every class and path of one version with the file that defined it. source is null for a class or path no repository defined (edited in Apiome, or imported before multi-repository merge).

version is a revision id or version label; the project's newest version when omitted.

Requires projects:view.

Operation id: list_project_repository_sources_v1_tenants__tenant_slug__projects__project_ref__repository_sources_get

Parameters

NameInTypeRequiredDescription
tenant_slugpathstringyesURL-safe tenant slug that scopes the request.
project_refpathstringyesPath parameter identifying the project ref segment.
versionquerystring or nullnoRevision id or version label.
authorizationheaderstring or nullnoJWT bearer token for authenticated access (Authorization: Bearer <token>).
X-API-Keyheaderstring or nullnoTenant-scoped API key used as an alternative to JWT bearer authentication.

Responses

StatusDescriptionBody
200Successful response for list a project's contributing repositories and per-entity provenance.application/json ProjectRepositorySourcesResponse
422Validation Errorapplication/json HTTPValidationError

Schemas used​

HTTPValidationError​

Validation error response emitted when request data fails schema checks.

PropertyTypeRequiredDescription
detailarray of ValidationErrornoDetail.

ProjectRepositorySourcesResponse​

A project's contributing repository files and one version's provenance.

PropertyTypeRequiredDescription
project_idstringyesProject identifier the resource belongs to.
sourcesarray of ProjectRepositorySourcenoContributing files in precedence order.
versionProvenanceVersion or nullnoThe version described; null when the project has none.
entitiesarray of EntityProvenancenoEvery live class (first) and path of the version, each ordered by key.
countsProvenanceCountsyesCounts.