lakeFS tags API
The tags API from lakeFS — 2 operation(s) for tags.
The tags API from lakeFS — 2 operation(s) for tags.
openapi: 3.0.0
info:
description: lakeFS HTTP API
title: lakeFS actions tags API
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.0
servers:
- url: /api/v1
description: lakeFS server endpoint
security:
- jwt_token: []
- basic_auth: []
- cookie_auth: []
- oidc_auth: []
- saml_auth: []
tags:
- name: tags
paths:
/repositories/{repository}/tags:
parameters:
- in: path
name: repository
required: true
schema:
type: string
get:
tags:
- tags
operationId: listTags
summary: list tags
parameters:
- $ref: '#/components/parameters/PaginationPrefix'
- $ref: '#/components/parameters/PaginationAfter'
- $ref: '#/components/parameters/PaginationAmount'
responses:
200:
description: tag list
content:
application/json:
schema:
$ref: '#/components/schemas/RefList'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
429:
description: too many requests
default:
$ref: '#/components/responses/ServerError'
post:
tags:
- tags
operationId: createTag
summary: create tag
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TagCreation'
responses:
201:
description: tag
content:
application/json:
schema:
$ref: '#/components/schemas/Ref'
400:
$ref: '#/components/responses/ValidationError'
401:
$ref: '#/components/responses/Unauthorized'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
409:
$ref: '#/components/responses/Conflict'
429:
description: too many requests
default:
$ref: '#/components/responses/ServerError'
/repositories/{repository}/tags/{tag}:
parameters:
- in: path
name: repository
required: true
schema:
type: string
- in: path
name: tag
required: true
schema:
type: string
get:
tags:
- tags
operationId: getTag
summary: get tag
responses:
200:
description: tag
content:
application/json:
schema:
$ref: '#/components/schemas/Ref'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
429:
description: too many requests
default:
$ref: '#/components/responses/ServerError'
delete:
tags:
- tags
operationId: deleteTag
summary: delete tag
parameters:
- in: query
name: force
required: false
schema:
type: boolean
responses:
204:
description: tag deleted successfully
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
429:
description: too many requests
default:
$ref: '#/components/responses/ServerError'
components:
responses:
Forbidden:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
ValidationError:
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
ServerError:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
BadRequest:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: Resource Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Conflict:
description: Resource Conflicts With Target
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
parameters:
PaginationAfter:
in: query
name: after
description: return items after this value
allowEmptyValue: true
schema:
type: string
PaginationPrefix:
in: query
name: prefix
allowEmptyValue: true
description: return items prefixed with this value
schema:
type: string
PaginationAmount:
in: query
name: amount
description: how many items to return
schema:
type: integer
minimum: -1
maximum: 1000
default: 100
schemas:
RefList:
type: object
required:
- pagination
- results
properties:
pagination:
$ref: '#/components/schemas/Pagination'
results:
type: array
items:
$ref: '#/components/schemas/Ref'
Pagination:
type: object
required:
- has_more
- max_per_page
- results
- next_offset
properties:
has_more:
type: boolean
description: Next page is available
next_offset:
type: string
description: Token used to retrieve the next page
results:
type: integer
minimum: 0
description: Number of values found in the results
max_per_page:
type: integer
minimum: 0
description: Maximal number of entries per page
Ref:
type: object
required:
- id
- commit_id
properties:
id:
type: string
commit_id:
type: string
Error:
type: object
required:
- message
properties:
message:
description: short message explaining the error
type: string
TagCreation:
type: object
description: Make tag ID point at this REF.
required:
- id
- ref
properties:
id:
type: string
description: ID of tag to create
ref:
type: string
description: the commit to tag
force:
type: boolean
default: false
securitySchemes:
basic_auth:
type: http
scheme: basic
jwt_token:
type: http
scheme: bearer
bearerFormat: JWT
cookie_auth:
type: apiKey
in: cookie
name: internal_auth_session
oidc_auth:
type: apiKey
in: cookie
name: oidc_auth_session
saml_auth:
type: apiKey
in: cookie
name: saml_auth_session