ansible_semaphore 1.2.3 ansible_semaphore: ^1.2.3 copied to clipboard
Ansible Semaphore API client
ansible_semaphore (EXPERIMENTAL) #
Semaphore API
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 2.2.0
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen
Requirements #
- Dart 2.15.0+ or Flutter 2.8.0+
- Dio 5.0.0+ (https://pub.dev/packages/dio)
- JSON Serializable 6.1.5+ (https://pub.dev/packages/json_serializable)
Installation & Usage #
pub.dev #
To use the package from pub.dev, please include the following in pubspec.yaml
dependencies:
ansible_semaphore: 1.2.3
Github #
If this Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
ansible_semaphore:
git:
url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
#ref: main
Local development #
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
ansible_semaphore:
path: /path/to/ansible_semaphore
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:ansible_semaphore/ansible_semaphore.dart';
final api = AnsibleSemaphore().getAuthenticationApi();
try {
final response = await api.authLoginGet();
print(response);
} catch on DioException (e) {
print("Exception when calling AuthenticationApi->authLoginGet: $e\n");
}
Documentation for API Endpoints #
All URIs are relative to http://localhost:3000/api
Class | Method | HTTP request | Description |
---|---|---|---|
AuthenticationApi | authLoginGet | GET /auth/login | Fetches login metadata |
AuthenticationApi | authLoginPost | POST /auth/login | Performs Login |
AuthenticationApi | authLogoutPost | POST /auth/logout | Destroys current session |
AuthenticationApi | authOidcProviderIdLoginGet | GET /auth/oidc/{provider_id}/login | Begin OIDC authentication flow and redirect to OIDC provider |
AuthenticationApi | authOidcProviderIdRedirectGet | GET /auth/oidc/{provider_id}/redirect | Finish OIDC authentication flow, upon succes you will be logged in |
AuthenticationApi | userTokensApiTokenIdDelete | DELETE /user/tokens/{api_token_id} | Expires API token |
AuthenticationApi | userTokensGet | GET /user/tokens | Fetch API tokens for user |
AuthenticationApi | userTokensPost | POST /user/tokens | Create an API token |
DefaultApi | eventsGet | GET /events | Get Events related to Semaphore and projects you are part of |
DefaultApi | eventsLastGet | GET /events/last | Get last 200 Events related to Semaphore and projects you are part of |
DefaultApi | infoGet | GET /info | Fetches information about semaphore |
DefaultApi | pingGet | GET /ping | PING test |
DefaultApi | wsGet | GET /ws | Websocket handler |
ProjectApi | projectProjectIdDelete | DELETE /project/{project_id}/ | Delete project |
ProjectApi | projectProjectIdEnvironmentEnvironmentIdDelete | DELETE /project/{project_id}/environment/{environment_id} | Removes environment |
ProjectApi | projectProjectIdEnvironmentEnvironmentIdPut | PUT /project/{project_id}/environment/{environment_id} | Update environment |
ProjectApi | projectProjectIdEnvironmentGet | GET /project/{project_id}/environment | Get environment |
ProjectApi | projectProjectIdEnvironmentPost | POST /project/{project_id}/environment | Add environment |
ProjectApi | projectProjectIdEventsGet | GET /project/{project_id}/events | Get Events related to this project |
ProjectApi | projectProjectIdEventsLastGet | GET /project/{project_id}/events/last | Get last 200 Events related to this project |
ProjectApi | projectProjectIdGet | GET /project/{project_id}/ | Fetch project |
ProjectApi | projectProjectIdInventoryGet | GET /project/{project_id}/inventory | Get inventory |
ProjectApi | projectProjectIdInventoryInventoryIdDelete | DELETE /project/{project_id}/inventory/{inventory_id} | Removes inventory |
ProjectApi | projectProjectIdInventoryInventoryIdPut | PUT /project/{project_id}/inventory/{inventory_id} | Updates inventory |
ProjectApi | projectProjectIdInventoryPost | POST /project/{project_id}/inventory | create inventory |
ProjectApi | projectProjectIdKeysGet | GET /project/{project_id}/keys | Get access keys linked to project |
ProjectApi | projectProjectIdKeysKeyIdDelete | DELETE /project/{project_id}/keys/{key_id} | Removes access key |
ProjectApi | projectProjectIdKeysKeyIdPut | PUT /project/{project_id}/keys/{key_id} | Updates access key |
ProjectApi | projectProjectIdKeysPost | POST /project/{project_id}/keys | Add access key |
ProjectApi | projectProjectIdPut | PUT /project/{project_id}/ | Update project |
ProjectApi | projectProjectIdRepositoriesGet | GET /project/{project_id}/repositories | Get repositories |
ProjectApi | projectProjectIdRepositoriesPost | POST /project/{project_id}/repositories | Add repository |
ProjectApi | projectProjectIdRepositoriesRepositoryIdDelete | DELETE /project/{project_id}/repositories/{repository_id} | Removes repository |
ProjectApi | projectProjectIdRepositoriesRepositoryIdPut | PUT /project/{project_id}/repositories/{repository_id} | Updates repository |
ProjectApi | projectProjectIdRoleGet | GET /project/{project_id}/role | Fetch permissions of the current user for project |
ProjectApi | projectProjectIdTasksGet | GET /project/{project_id}/tasks | Get Tasks related to current project |
ProjectApi | projectProjectIdTasksLastGet | GET /project/{project_id}/tasks/last | Get last 200 Tasks related to current project |
ProjectApi | projectProjectIdTasksPost | POST /project/{project_id}/tasks | Starts a job |
ProjectApi | projectProjectIdTasksTaskIdDelete | DELETE /project/{project_id}/tasks/{task_id} | Deletes task (including output) |
ProjectApi | projectProjectIdTasksTaskIdGet | GET /project/{project_id}/tasks/{task_id} | Get a single task |
ProjectApi | projectProjectIdTasksTaskIdOutputGet | GET /project/{project_id}/tasks/{task_id}/output | Get task output |
ProjectApi | projectProjectIdTasksTaskIdStopPost | POST /project/{project_id}/tasks/{task_id}/stop | Stop a job |
ProjectApi | projectProjectIdTemplatesGet | GET /project/{project_id}/templates | Get template |
ProjectApi | projectProjectIdTemplatesPost | POST /project/{project_id}/templates | create template |
ProjectApi | projectProjectIdTemplatesTemplateIdDelete | DELETE /project/{project_id}/templates/{template_id} | Removes template |
ProjectApi | projectProjectIdTemplatesTemplateIdGet | GET /project/{project_id}/templates/{template_id} | Get template |
ProjectApi | projectProjectIdTemplatesTemplateIdPut | PUT /project/{project_id}/templates/{template_id} | Updates template |
ProjectApi | projectProjectIdUsersGet | GET /project/{project_id}/users | Get users linked to project |
ProjectApi | projectProjectIdUsersPost | POST /project/{project_id}/users | Link user to project |
ProjectApi | projectProjectIdUsersUserIdDelete | DELETE /project/{project_id}/users/{user_id} | Removes user from project |
ProjectApi | projectProjectIdUsersUserIdPut | PUT /project/{project_id}/users/{user_id} | Change in-project role of user |
ProjectApi | projectProjectIdViewsGet | GET /project/{project_id}/views | Get view |
ProjectApi | projectProjectIdViewsPost | POST /project/{project_id}/views | create view |
ProjectApi | projectProjectIdViewsViewIdDelete | DELETE /project/{project_id}/views/{view_id} | Removes view |
ProjectApi | projectProjectIdViewsViewIdGet | GET /project/{project_id}/views/{view_id} | Get view |
ProjectApi | projectProjectIdViewsViewIdPut | PUT /project/{project_id}/views/{view_id} | Updates view |
ProjectsApi | projectsGet | GET /projects | Get projects |
ProjectsApi | projectsPost | POST /projects | Create a new project |
ScheduleApi | projectProjectIdSchedulesPost | POST /project/{project_id}/schedules | create schedule |
ScheduleApi | projectProjectIdSchedulesScheduleIdDelete | DELETE /project/{project_id}/schedules/{schedule_id} | Deletes schedule |
ScheduleApi | projectProjectIdSchedulesScheduleIdGet | GET /project/{project_id}/schedules/{schedule_id} | Get schedule |
ScheduleApi | projectProjectIdSchedulesScheduleIdPut | PUT /project/{project_id}/schedules/{schedule_id} | Updates schedule |
TaskApi | projectProjectIdTemplatesTemplateIdTasksLastGet | GET /project/{project_id}/templates/{template_id}/tasks/last | Get task of template |
UserApi | userGet | GET /user/ | Fetch logged in user |
UserApi | userTokensApiTokenIdDelete | DELETE /user/tokens/{api_token_id} | Expires API token |
UserApi | userTokensGet | GET /user/tokens | Fetch API tokens for user |
UserApi | userTokensPost | POST /user/tokens | Create an API token |
UserApi | usersGet | GET /users | Fetches all users |
UserApi | usersPost | POST /users | Creates a user |
UserApi | usersUserIdDelete | DELETE /users/{user_id}/ | Deletes user |
UserApi | usersUserIdGet | GET /users/{user_id}/ | Fetches a user profile |
UserApi | usersUserIdPasswordPost | POST /users/{user_id}/password | Updates user password |
UserApi | usersUserIdPut | PUT /users/{user_id}/ | Updates user details |
Documentation For Models #
- APIToken
- AccessKey
- AccessKeyRequest
- AccessKeyRequestLoginPassword
- AccessKeyRequestSsh
- Environment
- EnvironmentRequest
- Event
- InfoType
- InfoTypeUpdate
- Inventory
- InventoryRequest
- Login
- LoginMetadata
- LoginMetadataOidcProvidersInner
- Project
- ProjectProjectIdRoleGet200Response
- ProjectProjectIdTasksPostRequest
- ProjectProjectIdUsersPostRequest
- ProjectProjectIdUsersUserIdPutRequest
- ProjectRequest
- Repository
- RepositoryRequest
- Runner
- Schedule
- ScheduleRequest
- Task
- TaskOutput
- Template
- TemplateRequest
- TemplateSurveyVar
- User
- UserPutRequest
- UserRequest
- UsersUserIdPasswordPostRequest
- View
- ViewRequest
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