Skip to content

Latest commit

 

History

History
255 lines (212 loc) · 20.1 KB

README_OPENAPI.md

File metadata and controls

255 lines (212 loc) · 20.1 KB

semaphore-api

Semaphore API

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 2.2.0
  • Package version: 1.0.0
  • Generator version: 7.5.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/{owner}/{repo}.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/{owner}/{repo}.git)

Then import the package:

import semaphore_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import semaphore_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import semaphore_api
from semaphore_api.rest import ApiException
from pprint import pprint

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



# Enter a context with an instance of the API client
with semaphore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = semaphore_api.AuthenticationApi(api_client)

    try:
        # Fetches login metadata
        api_response = api_instance.auth_login_get()
        print("The response of AuthenticationApi->auth_login_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthenticationApi->auth_login_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:3000/api

Class Method HTTP request Description
AuthenticationApi auth_login_get GET /auth/login Fetches login metadata
AuthenticationApi auth_login_post POST /auth/login Performs Login
AuthenticationApi auth_logout_post POST /auth/logout Destroys current session
AuthenticationApi auth_oidc_provider_id_login_get GET /auth/oidc/{provider_id}/login Begin OIDC authentication flow and redirect to OIDC provider
AuthenticationApi auth_oidc_provider_id_redirect_get GET /auth/oidc/{provider_id}/redirect Finish OIDC authentication flow, upon succes you will be logged in
AuthenticationApi user_tokens_api_token_id_delete DELETE /user/tokens/{api_token_id} Expires API token
AuthenticationApi user_tokens_get GET /user/tokens Fetch API tokens for user
AuthenticationApi user_tokens_post POST /user/tokens Create an API token
DefaultApi events_get GET /events Get Events related to Semaphore and projects you are part of
DefaultApi events_last_get GET /events/last Get last 200 Events related to Semaphore and projects you are part of
DefaultApi info_get GET /info Fetches information about semaphore
DefaultApi ping_get GET /ping PING test
DefaultApi project_project_id_users_user_id_put PUT /project/{project_id}/users/{user_id} Update user role
DefaultApi ws_get GET /ws Websocket handler
IntegrationApi project_project_id_integrations_integration_id_matchers_get GET /project/{project_id}/integrations/{integration_id}/matchers Get Integration Matcher linked to integration extractor
IntegrationApi project_project_id_integrations_integration_id_matchers_matcher_id_delete DELETE /project/{project_id}/integrations/{integration_id}/matchers/{matcher_id} Removes integration matcher
IntegrationApi project_project_id_integrations_integration_id_matchers_matcher_id_put PUT /project/{project_id}/integrations/{integration_id}/matchers/{matcher_id} Updates Integration Matcher
IntegrationApi project_project_id_integrations_integration_id_values_extractvalue_id_delete DELETE /project/{project_id}/integrations/{integration_id}/values/{extractvalue_id} Removes integration extract value
IntegrationApi project_project_id_integrations_integration_id_values_extractvalue_id_put PUT /project/{project_id}/integrations/{integration_id}/values/{extractvalue_id} Updates Integration ExtractValue
IntegrationApi project_project_id_integrations_integration_id_values_get GET /project/{project_id}/integrations/{integration_id}/values Get Integration Extracted Values linked to integration extractor
ProjectApi project_project_id_backup_get GET /project/{project_id}/backup Backup A Project
ProjectApi project_project_id_delete DELETE /project/{project_id}/ Delete project
ProjectApi project_project_id_environment_environment_id_delete DELETE /project/{project_id}/environment/{environment_id} Removes environment
ProjectApi project_project_id_environment_environment_id_put PUT /project/{project_id}/environment/{environment_id} Update environment
ProjectApi project_project_id_environment_get GET /project/{project_id}/environment Get environment
ProjectApi project_project_id_environment_post POST /project/{project_id}/environment Add environment
ProjectApi project_project_id_events_get GET /project/{project_id}/events Get Events related to this project
ProjectApi project_project_id_get GET /project/{project_id}/ Fetch project
ProjectApi project_project_id_integrations_get GET /project/{project_id}/integrations get all integrations
ProjectApi project_project_id_integrations_integration_id_delete DELETE /project/{project_id}/integrations/{integration_id} Remove integration
ProjectApi project_project_id_integrations_integration_id_matchers_post POST /project/{project_id}/integrations/{integration_id}/matchers Add Integration Matcher
ProjectApi project_project_id_integrations_integration_id_put PUT /project/{project_id}/integrations/{integration_id} Update Integration
ProjectApi project_project_id_integrations_integration_id_values_post POST /project/{project_id}/integrations/{integration_id}/values Add Integration Extracted Value
ProjectApi project_project_id_integrations_post POST /project/{project_id}/integrations create a new integration
ProjectApi project_project_id_inventory_get GET /project/{project_id}/inventory Get inventory
ProjectApi project_project_id_inventory_inventory_id_delete DELETE /project/{project_id}/inventory/{inventory_id} Removes inventory
ProjectApi project_project_id_inventory_inventory_id_put PUT /project/{project_id}/inventory/{inventory_id} Updates inventory
ProjectApi project_project_id_inventory_post POST /project/{project_id}/inventory create inventory
ProjectApi project_project_id_keys_get GET /project/{project_id}/keys Get access keys linked to project
ProjectApi project_project_id_keys_key_id_delete DELETE /project/{project_id}/keys/{key_id} Removes access key
ProjectApi project_project_id_keys_key_id_put PUT /project/{project_id}/keys/{key_id} Updates access key
ProjectApi project_project_id_keys_post POST /project/{project_id}/keys Add access key
ProjectApi project_project_id_put PUT /project/{project_id}/ Update project
ProjectApi project_project_id_repositories_get GET /project/{project_id}/repositories Get repositories
ProjectApi project_project_id_repositories_post POST /project/{project_id}/repositories Add repository
ProjectApi project_project_id_repositories_repository_id_delete DELETE /project/{project_id}/repositories/{repository_id} Removes repository
ProjectApi project_project_id_repositories_repository_id_put PUT /project/{project_id}/repositories/{repository_id} Updates repository
ProjectApi project_project_id_role_get GET /project/{project_id}/role Fetch permissions of the current user for project
ProjectApi project_project_id_tasks_get GET /project/{project_id}/tasks Get Tasks related to current project
ProjectApi project_project_id_tasks_last_get GET /project/{project_id}/tasks/last Get last 200 Tasks related to current project
ProjectApi project_project_id_tasks_post POST /project/{project_id}/tasks Starts a job
ProjectApi project_project_id_tasks_task_id_delete DELETE /project/{project_id}/tasks/{task_id} Deletes task (including output)
ProjectApi project_project_id_tasks_task_id_get GET /project/{project_id}/tasks/{task_id} Get a single task
ProjectApi project_project_id_tasks_task_id_output_get GET /project/{project_id}/tasks/{task_id}/output Get task output
ProjectApi project_project_id_tasks_task_id_stop_post POST /project/{project_id}/tasks/{task_id}/stop Stop a job
ProjectApi project_project_id_templates_get GET /project/{project_id}/templates Get template
ProjectApi project_project_id_templates_post POST /project/{project_id}/templates create template
ProjectApi project_project_id_templates_template_id_delete DELETE /project/{project_id}/templates/{template_id} Removes template
ProjectApi project_project_id_templates_template_id_get GET /project/{project_id}/templates/{template_id} Get template
ProjectApi project_project_id_templates_template_id_put PUT /project/{project_id}/templates/{template_id} Updates template
ProjectApi project_project_id_users_get GET /project/{project_id}/users Get users linked to project
ProjectApi project_project_id_users_post POST /project/{project_id}/users Link user to project
ProjectApi project_project_id_users_user_id_delete DELETE /project/{project_id}/users/{user_id} Removes user from project
ProjectApi project_project_id_views_get GET /project/{project_id}/views Get view
ProjectApi project_project_id_views_post POST /project/{project_id}/views create view
ProjectApi project_project_id_views_view_id_delete DELETE /project/{project_id}/views/{view_id} Removes view
ProjectApi project_project_id_views_view_id_get GET /project/{project_id}/views/{view_id} Get view
ProjectApi project_project_id_views_view_id_put PUT /project/{project_id}/views/{view_id} Updates view
ProjectsApi projects_get GET /projects Get projects
ProjectsApi projects_post POST /projects Create a new project
ProjectsApi projects_restore_post POST /projects/restore Restore Project
ScheduleApi project_project_id_schedules_post POST /project/{project_id}/schedules create schedule
ScheduleApi project_project_id_schedules_schedule_id_delete DELETE /project/{project_id}/schedules/{schedule_id} Deletes schedule
ScheduleApi project_project_id_schedules_schedule_id_get GET /project/{project_id}/schedules/{schedule_id} Get schedule
ScheduleApi project_project_id_schedules_schedule_id_put PUT /project/{project_id}/schedules/{schedule_id} Updates schedule
UserApi user_get GET /user/ Fetch logged in user
UserApi user_tokens_api_token_id_delete DELETE /user/tokens/{api_token_id} Expires API token
UserApi user_tokens_get GET /user/tokens Fetch API tokens for user
UserApi user_tokens_post POST /user/tokens Create an API token
UserApi users_get GET /users Fetches all users
UserApi users_post POST /users Creates a user
UserApi users_user_id_delete DELETE /users/{user_id}/ Deletes user
UserApi users_user_id_get GET /users/{user_id}/ Fetches a user profile
UserApi users_user_id_password_post POST /users/{user_id}/password Updates user password
UserApi users_user_id_put PUT /users/{user_id}/ Updates user details

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

cookie

  • Type: API key
  • API key parameter name: Cookie
  • Location: HTTP header

bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author