Verta VersioningService API

openapi: 3.2.0
info:
  title: deployment/APISync.proto AuthzService Versioning Service API
  version: version not set
servers:
- url: /v1
tags:
- name: VersioningService
paths:
  /versioning/commitMultipartVersionedBlobArtifact:
    post:
      operationId: VersioningService_commitMultipartVersionedBlobArtifact
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningCommitMultipartVersionedBlobArtifactResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      tags:
      - VersioningService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/versioningCommitMultipartVersionedBlobArtifact'
        required: true
  /versioning/commitVersionedBlobArtifactPart:
    post:
      operationId: VersioningService_commitVersionedBlobArtifactPart
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningCommitVersionedBlobArtifactPartResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      tags:
      - VersioningService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/versioningCommitVersionedBlobArtifactPart'
        required: true
  /versioning/getCommittedVersionedBlobArtifactParts:
    get:
      operationId: VersioningService_getCommittedVersionedBlobArtifactParts
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningGetCommittedVersionedBlobArtifactPartsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.repo_id
        in: query
        required: false
        schema:
          type: string
          format: uint64
      - name: commit_sha
        in: query
        required: false
        schema:
          type: string
      - name: location
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: path_dataset_component_blob_path
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
  /versioning/repositories:
    get:
      summary: CRUD for repositories
      operationId: VersioningService_ListRepositories2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningListRepositoriesRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: workspace_name
        in: query
        required: false
        schema:
          type: string
      - name: pagination.page_number
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: pagination.page_limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      tags:
      - VersioningService
  /versioning/repositories/{id.repo_id}:
    get:
      operationId: VersioningService_GetRepository2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningGetRepositoryRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
    put:
      operationId: VersioningService_UpdateRepository2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningSetRepositoryResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/versioningRepository'
        required: true
  /versioning/repositories/{repository_id.repo_id}:
    delete:
      operationId: VersioningService_DeleteRepository2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningDeleteRepositoryRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
  /versioning/repositories/{repository_id.repo_id}/branches:
    get:
      summary: CRUD for Branches
      operationId: VersioningService_ListBranches2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningListBranchesRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
  /versioning/repositories/{repository_id.repo_id}/branches/{branch}:
    get:
      operationId: VersioningService_GetBranch2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningGetBranchRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: branch
        in: path
        required: true
        schema:
          type: string
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
    delete:
      operationId: VersioningService_DeleteBranch2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningDeleteBranchRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: branch
        in: path
        required: true
        schema:
          type: string
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
    put:
      summary: Unlike tags, branches can be updated. The API must verify that the new commit is a child of the current branch.
      operationId: VersioningService_SetBranch2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningSetBranchRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: branch
        in: path
        required: true
        schema:
          type: string
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
      requestBody:
        content:
          application/json:
            schema:
              type: string
        required: true
  /versioning/repositories/{repository_id.repo_id}/branches/{branch}/log:
    get:
      operationId: VersioningService_ListCommitsLog2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningListCommitsLogRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: branch
        description: Pagination pagination = 2;
        in: path
        required: true
        schema:
          type: string
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      - name: commit_sha
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
  /versioning/repositories/{repository_id.repo_id}/commits:
    get:
      summary: CRUD for commits
      operationId: VersioningService_ListCommits2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningListCommitsRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      - name: pagination.page_number
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: pagination.page_limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: commit_base
        in: query
        required: false
        schema:
          type: string
      - name: commit_head
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
    post:
      operationId: VersioningService_CreateCommit2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningCreateCommitRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      tags:
      - VersioningService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/versioningCreateCommitRequest'
        required: true
  /versioning/repositories/{repository_id.repo_id}/commits/{commit_sha}:
    get:
      operationId: VersioningService_GetCommit2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningGetCommitRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: commit_sha
        in: path
        required: true
        schema:
          type: string
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
    delete:
      operationId: VersioningService_DeleteCommit2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningDeleteCommitRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: commit_sha
        in: path
        required: true
        schema:
          type: string
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
  /versioning/repositories/{repository_id.repo_id}/commits/{commit_sha}/blobs:
    get:
      summary: Getting blobs and folders in a commit
      operationId: VersioningService_ListCommitBlobs2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningListCommitBlobsRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: commit_sha
        description: Pagination pagination = 2;
        in: path
        required: true
        schema:
          type: string
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      - name: location_prefix
        description: 'List of folder names (with the last element potentially representing the blob name)

          This will be used to limit the search to scope just this location, like `git log /my/path` would do.'
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      tags:
      - VersioningService
  /versioning/repositories/{repository_id.repo_id}/commits/{commit_sha}/getUrlForBlobVersioned:
    post:
      operationId: VersioningService_getUrlForBlobVersioned2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningGetUrlForBlobVersionedResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: commit_sha
        in: path
        required: true
        schema:
          type: string
      tags:
      - VersioningService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/versioningGetUrlForBlobVersioned'
        required: true
  /versioning/repositories/{repository_id.repo_id}/commits/{commit_sha}/log:
    get:
      operationId: VersioningService_ListCommitsLog4
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningListCommitsLogRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: commit_sha
        in: path
        required: true
        schema:
          type: string
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      - name: branch
        description: Pagination pagination = 2;.
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
  /versioning/repositories/{repository_id.repo_id}/commits/{commit_sha}/path:
    get:
      operationId: VersioningService_GetCommitComponent2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningGetCommitComponentRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: commit_sha
        in: path
        required: true
        schema:
          type: string
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      - name: location
        description: 'List of folder names, with the last element being the name of the blob or tree

          the last element determines if the response to be returned is Folder or Blob

          Each element goes one level deeper. So ["foo", "bar"] represents the same as /foo/bar.'
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      tags:
      - VersioningService
  /versioning/repositories/{repository_id.repo_id}/commits/{commit_to_revert_sha}/revert:
    post:
      operationId: VersioningService_RevertRepositoryCommits2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningRevertRepositoryCommitsRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: commit_to_revert_sha
        in: path
        required: true
        schema:
          type: string
      tags:
      - VersioningService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/versioningRevertRepositoryCommitsRequest'
        required: true
  /versioning/repositories/{repository_id.repo_id}/diff:
    get:
      summary: Git-like operations
      operationId: VersioningService_ComputeRepositoryDiff2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningComputeRepositoryDiffRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      - name: commit_a
        in: query
        required: false
        schema:
          type: string
      - name: commit_b
        in: query
        required: false
        schema:
          type: string
      - name: replace_a_with_common_ancestor
        description: Replace commit_a with the nearest common ancestor of commit_a and commit_b.
        in: query
        required: false
        schema:
          type: boolean
      - name: branch_a
        description: for a or b only one of commit or branch should be populated.
        in: query
        required: false
        schema:
          type: string
      - name: branch_b
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
  /versioning/repositories/{repository_id.repo_id}/merge:
    post:
      operationId: VersioningService_MergeRepositoryCommits2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningMergeRepositoryCommitsRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      tags:
      - VersioningService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/versioningMergeRepositoryCommitsRequest'
        required: true
  /versioning/repositories/{repository_id.repo_id}/tags:
    get:
      summary: CRUD for tags
      operationId: VersioningService_ListTags2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningListTagsRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
  /versioning/repositories/{repository_id.repo_id}/tags/{tag}:
    get:
      operationId: VersioningService_GetTag2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningGetTagRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: tag
        in: path
        required: true
        schema:
          type: string
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
    delete:
      operationId: VersioningService_DeleteTag2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningDeleteTagRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: tag
        in: path
        required: true
        schema:
          type: string
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
    put:
      summary: Can't update a tag. If someone tries to set one that exists, we should error.
      operationId: VersioningService_SetTag2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningSetTagRequestResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: repository_id.repo_id
        in: path
        required: true
        schema:
          type: string
          format: uint64
      - name: tag
        in: path
        required: true
        schema:
          type: string
      - name: repository_id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: repository_id.named_id.workspace_name
        in: query
        required: false
        schema:
          type: string
      tags:
      - VersioningService
      requestBody:
        content:
          application/json:
            schema:
              type: string
        required: true
  /versioning/workspaces/{id.named_id.workspace_name}/repositories:
    post:
      operationId: VersioningService_CreateRepository
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/versioningSetRepositoryResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: id.named_id.workspace_name
        in: path
        required: true
        schema:
          type: string
      - name: id.named_id.name
        in: query
        required: false
        schema:
          type: string
      - name: id.repo_id
        in: query
        required: false
        schema:
          type: string
          format: uint64
      tags:
      - VersioningService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/versioningRepository'
        required: true
  /versioning/workspaces/{id.named_id.workspace_name}/repositories/{id.named_id.name}:
    get:
      operationId: Versio

# --- truncated at 32 KB (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/verta/refs/heads/main/openapi/verta-versioningservice-api-openapi.yml