compute_api_client.CommitsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
compile_commit_commits_id_compile_post	POST /commits/{id}/compile	Compile file in a commit
create_commit_commits_post	POST /commits	Create commit
delete_commit_commits_id_delete	DELETE /commits/{id}	Destroy commit
read_commit_commits_id_get	GET /commits/{id}	Get commit by ID
read_commits_commits_get	GET /commits	List commits

compile_commit_commits_id_compile_post

compile_commit_commits_id_compile_post(id, compile_payload)

Compile file in a commit

Compile file in a commit.

Example

OAuth Authentication (user_bearer):
Api Key Authentication (backend):

import time
import os
import compute_api_client
from compute_api_client.models.compile_payload import CompilePayload
from compute_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = compute_api_client.Configuration(
    host = "http://localhost"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

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

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

# Enter a context with an instance of the API client
async with compute_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = compute_api_client.CommitsApi(api_client)
    id = 56 # int | 
    compile_payload = compute_api_client.CompilePayload() # CompilePayload | 

    try:
        # Compile file in a commit
        await api_instance.compile_commit_commits_id_compile_post(id, compile_payload)
    except Exception as e:
        print("Exception when calling CommitsApi->compile_commit_commits_id_compile_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
compile_payload	CompilePayload

Return type

void (empty response body)

Authorization

user_bearer, backend

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	Compiled	-
404	Not Found	-
400	Bad Request	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_commit_commits_post

Commit create_commit_commits_post(commit_in)

Create commit

Create new commit.

Example

OAuth Authentication (user_bearer):

import time
import os
import compute_api_client
from compute_api_client.models.commit import Commit
from compute_api_client.models.commit_in import CommitIn
from compute_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = compute_api_client.Configuration(
    host = "http://localhost"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
async with compute_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = compute_api_client.CommitsApi(api_client)
    commit_in = compute_api_client.CommitIn() # CommitIn | 

    try:
        # Create commit
        api_response = await api_instance.create_commit_commits_post(commit_in)
        print("The response of CommitsApi->create_commit_commits_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CommitsApi->create_commit_commits_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
commit_in	CommitIn

Return type

Commit

Authorization

user_bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_commit_commits_id_delete

delete_commit_commits_id_delete(id)

Destroy commit

Delete a commit.

Example

OAuth Authentication (user_bearer):

import time
import os
import compute_api_client
from compute_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = compute_api_client.Configuration(
    host = "http://localhost"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
async with compute_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = compute_api_client.CommitsApi(api_client)
    id = 56 # int | 

    try:
        # Destroy commit
        await api_instance.delete_commit_commits_id_delete(id)
    except Exception as e:
        print("Exception when calling CommitsApi->delete_commit_commits_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

void (empty response body)

Authorization

user_bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Successful Response	-
404	Not Found	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read_commit_commits_id_get

Commit read_commit_commits_id_get(id)

Get commit by ID

Get commit by ID.

Example

OAuth Authentication (user_bearer):
Api Key Authentication (backend):

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

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = compute_api_client.Configuration(
    host = "http://localhost"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

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

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

# Enter a context with an instance of the API client
async with compute_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = compute_api_client.CommitsApi(api_client)
    id = 56 # int | 

    try:
        # Get commit by ID
        api_response = await api_instance.read_commit_commits_id_get(id)
        print("The response of CommitsApi->read_commit_commits_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CommitsApi->read_commit_commits_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

Commit

Authorization

user_bearer, backend

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
404	Not Found	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read_commits_commits_get

PageCommit read_commits_commits_get(id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id, sort_by=sort_by, latest=latest, page=page, size=size)

List commits

List commits.

Example

OAuth Authentication (user_bearer):

import time
import os
import compute_api_client
from compute_api_client.models.page_commit import PageCommit
from compute_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = compute_api_client.Configuration(
    host = "http://localhost"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
async with compute_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = compute_api_client.CommitsApi(api_client)
    id = 56 # int |  (optional)
    created_on = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    hash = 'hash_example' # str |  (optional)
    description = 'description_example' # str |  (optional)
    algorithm_id = 56 # int |  (optional)
    sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional)
    latest = True # bool | If True gets the most recently created object. (optional)
    page = 1 # int | Page number (optional) (default to 1)
    size = 50 # int | Page size (optional) (default to 50)

    try:
        # List commits
        api_response = await api_instance.read_commits_commits_get(id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id, sort_by=sort_by, latest=latest, page=page, size=size)
        print("The response of CommitsApi->read_commits_commits_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CommitsApi->read_commits_commits_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int		[optional]
created_on	datetime		[optional]
hash	str		[optional]
description	str		[optional]
algorithm_id	int		[optional]
sort_by	str	The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.	[optional]
latest	bool	If True gets the most recently created object.	[optional]
page	int	Page number	[optional] [default to 1]
size	int	Page size	[optional] [default to 50]

Return type

PageCommit

Authorization

user_bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

CommitsApi.md

Latest commit

History

CommitsApi.md

File metadata and controls

compute_api_client.CommitsApi

compile_commit_commits_id_compile_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_commit_commits_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_commit_commits_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

read_commit_commits_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

read_commits_commits_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details