Skip to content

ResultApi.md

Latest commit

 

History

History
363 lines (252 loc) · 10.6 KB

ResultApi.md

File metadata and controls

363 lines (252 loc) · 10.6 KB

ibutsu_client.ResultApi

All URIs are relative to /api

Method HTTP request Description
add_result POST /result Create a test result
get_result GET /result/{id} Get a single result
get_result_list GET /result Get the list of results.
update_result PUT /result/{id} Updates a single result

add_result

Result add_result(result=result)

Create a test result

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.result import Result
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.ResultApi(api_client)
    result = ibutsu_client.Result() # Result | Result item (optional)

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

Parameters

Name Type Description Notes
result Result Result item [optional]

Return type

Result

Authorization

jwt

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Created -
400 Bad request, JSON required or not enough parameters -

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

get_result

Result get_result(id)

Get a single result

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.result import Result
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.ResultApi(api_client)
    id = 'id_example' # str | ID of result to return (uuid required)

    try:
        # Get a single result
        api_response = api_instance.get_result(id)
        print("The response of ResultApi->get_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResultApi->get_result: %s\n" % e)

Parameters

Name Type Description Notes
id str ID of result to return (uuid required)

Return type

Result

Authorization

jwt

HTTP request headers

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

HTTP response details

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

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

get_result_list

ResultList get_result_list(filter=filter, estimate=estimate, page=page, page_size=page_size)

Get the list of results.

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:

/result?filter=metadata.run=63fe5
/result?filter=test_id~neg
/result?filter=result!passed

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.result_list import ResultList
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.ResultApi(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 the list of results.
        api_response = api_instance.get_result_list(filter=filter, estimate=estimate, page=page, page_size=page_size)
        print("The response of ResultApi->get_result_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResultApi->get_result_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

ResultList

Authorization

jwt

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
201 Query being evaluated in a celery task -

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

update_result

Result update_result(id, result=result)

Updates a single result

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.result import Result
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.ResultApi(api_client)
    id = 'id_example' # str | ID of result to update
    result = ibutsu_client.Result() # Result | Result item (optional)

    try:
        # Updates a single result
        api_response = api_instance.update_result(id, result=result)
        print("The response of ResultApi->update_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResultApi->update_result: %s\n" % e)

Parameters

Name Type Description Notes
id str ID of result to update
result Result Result item [optional]

Return type

Result

Authorization

jwt

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request, JSON required or not enough parameters -
404 Result not found -

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