lakefs_enterprise_sdk.CommitsApi¶

All URIs are relative to /api/v1

Method	HTTP request	Description
commit	POST /repositories/{repository}/branches/{branch}/commits	create commit
get_commit	GET /repositories/{repository}/commits/{commitId}	get commit

commit¶

Commit commit(repository, branch, commit_creation, source_metarange=source_metarange)

create commit

Example¶

Basic Authentication (basic_auth):
Api Key Authentication (cookie_auth):
Api Key Authentication (oidc_auth):
Api Key Authentication (saml_auth):

Bearer (JWT) Authentication (jwt_token):

import time
import os
import lakefs_enterprise_sdk
from lakefs_enterprise_sdk.models.commit import Commit
from lakefs_enterprise_sdk.models.commit_creation import CommitCreation
from lakefs_enterprise_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_enterprise_sdk.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basic_auth
configuration = lakefs_enterprise_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['oidc_auth'] = 'Bearer'

# Configure API key authorization: saml_auth
configuration.api_key['saml_auth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_enterprise_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_enterprise_sdk.CommitsApi(api_client)
    repository = 'repository_example' # str | 
    branch = 'branch_example' # str | 
    commit_creation = lakefs_enterprise_sdk.CommitCreation() # CommitCreation | 
    source_metarange = 'source_metarange_example' # str | The source metarange to commit. Branch must not have uncommitted changes. (optional)

    try:
        # create commit
        api_response = api_instance.commit(repository, branch, commit_creation, source_metarange=source_metarange)
        print("The response of CommitsApi->commit:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CommitsApi->commit: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
repository	str
branch	str
commit_creation	CommitCreation
source_metarange	str	The source metarange to commit. Branch must not have uncommitted changes.	[optional]

Return type¶

Commit

Authorization¶

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers¶

Content-Type: application/json
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
201	commit	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
409	Resource Conflicts With Target	-
412	Precondition Failed	-
429	too many requests	-
0	Internal Server Error	-

get_commit¶

Commit get_commit(repository, commit_id)

get commit

Example¶

Basic Authentication (basic_auth):
Api Key Authentication (cookie_auth):
Api Key Authentication (oidc_auth):
Api Key Authentication (saml_auth):

Bearer (JWT) Authentication (jwt_token):

import time
import os
import lakefs_enterprise_sdk
from lakefs_enterprise_sdk.models.commit import Commit
from lakefs_enterprise_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_enterprise_sdk.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basic_auth
configuration = lakefs_enterprise_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['oidc_auth'] = 'Bearer'

# Configure API key authorization: saml_auth
configuration.api_key['saml_auth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_enterprise_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_enterprise_sdk.CommitsApi(api_client)
    repository = 'repository_example' # str | 
    commit_id = 'commit_id_example' # str | 

    try:
        # get commit
        api_response = api_instance.get_commit(repository, commit_id)
        print("The response of CommitsApi->get_commit:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CommitsApi->get_commit: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
repository	str
commit_id	str

Return type¶

Commit

Authorization¶

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	commit	-
400	Bad Request	-
401	Unauthorized	-
404	Resource Not Found	-
429	too many requests	-
0	Internal Server Error	-