Skip to content

Latest commit

 

History

History
executable file
·
216 lines (154 loc) · 6.68 KB

InternalServiceApi.md

File metadata and controls

executable file
·
216 lines (154 loc) · 6.68 KB
Raw

swagger_client.InternalServiceApi

All URIs are relative to http://api.teke.li:9090

Method HTTP request Description
branding GET /api/internal/branding Get the branding for the UI
global_search GET /api/internal/search Perform a global search.
login POST /api/internal/login Log in a user
profile GET /api/internal/profile Get the current user's profile

branding

ApiBrandingResponse branding()

Get the branding for the UI

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeaderAuth
configuration = swagger_client.Configuration()
configuration.api_key['Grpc-Metadata-Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Grpc-Metadata-Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.InternalServiceApi(swagger_client.ApiClient(configuration))

try:
    # Get the branding for the UI
    api_response = api_instance.branding()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternalServiceApi->branding: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ApiBrandingResponse

Authorization

ApiKeyHeaderAuth

HTTP request headers

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

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

global_search

ApiGlobalSearchResponse global_search(search=search, limit=limit, offset=offset)

Perform a global search.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeaderAuth
configuration = swagger_client.Configuration()
configuration.api_key['Grpc-Metadata-Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Grpc-Metadata-Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.InternalServiceApi(swagger_client.ApiClient(configuration))
search = 'search_example' # str | Search query. (optional)
limit = 'limit_example' # str | Max number of results to return. (optional)
offset = 'offset_example' # str | Offset offset of the result-set (for pagination). (optional)

try:
    # Perform a global search.
    api_response = api_instance.global_search(search=search, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternalServiceApi->global_search: %s\n" % e)

Parameters

Name Type Description Notes
search str Search query. [optional]
limit str Max number of results to return. [optional]
offset str Offset offset of the result-set (for pagination). [optional]

Return type

ApiGlobalSearchResponse

Authorization

ApiKeyHeaderAuth

HTTP request headers

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

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

login

ApiLoginResponse login(body)

Log in a user

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeaderAuth
configuration = swagger_client.Configuration()
configuration.api_key['Grpc-Metadata-Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Grpc-Metadata-Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.InternalServiceApi(swagger_client.ApiClient(configuration))
body = swagger_client.ApiLoginRequest() # ApiLoginRequest | 

try:
    # Log in a user
    api_response = api_instance.login(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternalServiceApi->login: %s\n" % e)

Parameters

Name Type Description Notes
body ApiLoginRequest

Return type

ApiLoginResponse

Authorization

ApiKeyHeaderAuth

HTTP request headers

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

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

profile

ApiProfileResponse profile()

Get the current user's profile

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeaderAuth
configuration = swagger_client.Configuration()
configuration.api_key['Grpc-Metadata-Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Grpc-Metadata-Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.InternalServiceApi(swagger_client.ApiClient(configuration))

try:
    # Get the current user's profile
    api_response = api_instance.profile()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternalServiceApi->profile: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ApiProfileResponse

Authorization

ApiKeyHeaderAuth

HTTP request headers

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

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