Skip to content

Latest commit

 

History

History
450 lines (313 loc) · 13.1 KB

RunApi.md

File metadata and controls

450 lines (313 loc) · 13.1 KB

ibutsu_client.RunApi

All URIs are relative to /api

Method HTTP request Description
add_run POST /run Create a run
bulk_update POST /runs/bulk-update Update multiple runs with common metadata
get_run GET /run/{id} Get a single run by ID (uuid required)
get_run_list GET /run Get a list of the test runs
update_run PUT /run/{id} Update a single run

add_run

Run add_run(run=run)

Create a run

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.run import Run
from ibutsu_client.rest import ApiException
from pprint import pprint

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

# 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 Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.RunApi(api_client)
    run = ibutsu_client.Run() # Run | A run object (optional)

    try:
        # Create a run
        api_response = api_instance.add_run(run=run)
        print("The response of RunApi->add_run:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RunApi->add_run: %s\n" % e)

Parameters

Name Type Description Notes
run Run A run object [optional]

Return type

Run

Authorization

jwt

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 A Run was created -
400 Bad request, JSON required -

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

bulk_update

RunList bulk_update(filter=filter, page_size=page_size, update_run=update_run)

Update multiple runs with common metadata

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.run_list import RunList
from ibutsu_client.models.update_run import UpdateRun
from ibutsu_client.rest import ApiException
from pprint import pprint

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

# 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 Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.RunApi(api_client)
    filter = ['filter_example'] # List[str] | Fields to filter by (optional)
    page_size = 56 # int | Set the number of items per page, defaults to 25 (optional)
    update_run = ibutsu_client.UpdateRun() # UpdateRun | Run metadata updates (optional)

    try:
        # Update multiple runs with common metadata
        api_response = api_instance.bulk_update(filter=filter, page_size=page_size, update_run=update_run)
        print("The response of RunApi->bulk_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RunApi->bulk_update: %s\n" % e)

Parameters

Name Type Description Notes
filter List[str] Fields to filter by [optional]
page_size int Set the number of items per page, defaults to 25 [optional]
update_run UpdateRun Run metadata updates [optional]

Return type

RunList

Authorization

jwt

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Updated Run -
400 Bad request, JSON required -
401 Bad request, can only update metadata -
404 Filter(s) returned no Runs -
405 Bad request, cannot update more than 25 runs at a time -

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

get_run

Run get_run(id)

Get a single run by ID (uuid required)

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.run import Run
from ibutsu_client.rest import ApiException
from pprint import pprint

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

# 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 Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.RunApi(api_client)
    id = 'id_example' # str | ID of test run

    try:
        # Get a single run by ID (uuid required)
        api_response = api_instance.get_run(id)
        print("The response of RunApi->get_run:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RunApi->get_run: %s\n" % e)

Parameters

Name Type Description Notes
id str ID of test run

Return type

Run

Authorization

jwt

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Run item -
404 Run not found -

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

get_run_list

RunList get_run_list(filter=filter, estimate=estimate, page=page, page_size=page_size)

Get a list of the test runs

The filter parameter takes a list of filters to apply in the form of:

{name}{operator}{value}

where:

  • name is any valid column in the database
  • operator is one of =, !, ＞, ＜, ), (, ~, *
  • value is what you want to filter by

Operators are simple correspondents to MongoDB's query selectors:

  • = becomes $eq
  • ! becomes $ne
  • ＞ becomes $gt
  • ＜ becomes $lt
  • ) becomes $gte
  • ( becomes $lte
  • ~ becomes $regex
  • * becomes $in
  • @ becomes $exists

Notes:

  • For the $exists operator, "true", "t", "yes", "y" and 1 will all be considered true, all other values are considered false.

Example queries:

/run?filter=metadata.jenkins.job_name=jenkins_job
/run?filter=summary.failures>0

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.run_list import RunList
from ibutsu_client.rest import ApiException
from pprint import pprint

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

# 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 Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.RunApi(api_client)
    filter = ['filter_example'] # List[str] | Fields to filter by (optional)
    estimate = True # bool | Return an estimated count (optional)
    page = 56 # int | Set the page of items to return, defaults to 1 (optional)
    page_size = 56 # int | Set the number of items per page, defaults to 25 (optional)

    try:
        # Get a list of the test runs
        api_response = api_instance.get_run_list(filter=filter, estimate=estimate, page=page, page_size=page_size)
        print("The response of RunApi->get_run_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RunApi->get_run_list: %s\n" % e)

Parameters

Name Type Description Notes
filter List[str] Fields to filter by [optional]
estimate bool Return an estimated count [optional]
page int Set the page of items to return, defaults to 1 [optional]
page_size int Set the number of items per page, defaults to 25 [optional]

Return type

RunList

Authorization

jwt

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Array of Runs -
201 Query being evaluated in a celery task -

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

update_run

Run update_run(id, run=run)

Update a single run

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.run import Run
from ibutsu_client.rest import ApiException
from pprint import pprint

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

# 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 Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.RunApi(api_client)
    id = 'id_example' # str | ID of the test run
    run = ibutsu_client.Run() # Run | A run object (optional)

    try:
        # Update a single run
        api_response = api_instance.update_run(id, run=run)
        print("The response of RunApi->update_run:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RunApi->update_run: %s\n" % e)

Parameters

Name Type Description Notes
id str ID of the test run
run Run A run object [optional]

Return type

Run

Authorization

jwt

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Updated Run -
400 Bad request, JSON required -
404 Run not found -

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