Public Repositories

Render a redacted effective Compose preview for a public repository.

Changed on
post/git/public/{provider}/{owner}/{repo}/compose-file

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/git/public/{provider}/{owner}/{repo}/compose-file
  • Auth: none declared

Path parameters

providerstring required

Git provider (github or gitlab)

ownerstring required

Repository owner

repostring required

Repository name

Query parameters

base_urlstring nullable

HTTPS/443 origin of a self-hosted GitLab instance. Requires authentication and git_repositories:read.

Request body

branchstring nullable
composeOverridestring nullable
excludedServicesstring[]
pathstring required

Response

Effective Compose preview rendered

branchstring required
disabledServicesstring[] required
effectiveComposestring required

Effective user-controlled Compose YAML with sensitive values redacted.

enabledServicesstring[] required
pathstring required
redactedValuesinteger required

Changes

  • 4b228ebed583Revision changes
    • info

      added the new optional request property

    • info

      added the media type application/problem+json for the response with the status

  • 1dc3e6788214Revision changes
    • breaking

      removed the media type application/problem+json for the response with the status

    • warning

      removed the request property