Simple Elixir wrapper for the AWX API.
📚 Table Of Contents
🚀 Getting Started
If available in Hex, the package can be installed
by adding awex
to your list of dependencies in mix.exs
:
def deps do
[
{:awex, "~> 0.1.0"}
]
end
Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/awex.
⚙️ Configuration
- (Optional) AWeX comes with AWeX.HTTPClient.Finch configured by default. If you want to use it, you just need to include Finch as a dependency of your app.
AWeX also accepts Hackney out-of-the-box. See Swoosh.HTTPClient.Hackney for details.
If you need to integrate with another HTTP client, it's easy to define a new API client. Follow the AWeX.HTTPClient behaviour and configure AWeX to use it:
config :awex, :http_client, MyApp.HTTPClient
Todo
- [:red_circle:] ping
- [:red_circle:] Instances
- [:red_circle:] Instance Groups
- [:red_circle:] config
- [:red_circle:] settings
- [:red_circle:] me
- [:red_circle:] dashboard
- [:red_circle:] organizations
- [:red_circle:] users
- [:red_circle:] execution_environments
- [:red_circle:] projects
- [:red_circle:] project_updates
- [:red_circle:] teams
- [:red_circle:] credentials
- [:red_circle:] credential_types
- [:red_circle:] credential_input_sources
- [:red_circle:] applications
- [:red_circle:] tokens
- [:red_circle:] metrics
- [:red_circle:] inventory
- [:red_circle:] inventory_sources
- [:red_circle:] inventory_updates
- [:red_circle:] groups
- [:red_circle:] hosts
- [:yellow_circle:] job_templates
- [:yellow_circle:] jobs
- [:red_circle:] ad_hoc_commands
- [:red_circle:] system_job_templates
- [:red_circle:] system_jobs
- [:red_circle:] schedules
- [:red_circle:] roles
- [:red_circle:] notification_templates
- [:red_circle:] notifications
- [:red_circle:] labels
- [:red_circle:] unified_job_templates
- [:red_circle:] unified_jobs
- [:red_circle:] activity_stream
- [:red_circle:] workflow_job_templates
- [:red_circle:] workflow_jobs
- [:red_circle:] workflow_approvals
- [:red_circle:] workflow_job_template_nodes
- [:red_circle:] workflow_job_nodes
- [:red_circle:] mesh_visualizer
🔗 Links
🛡️ License
AWeX is licensed under the MIT License - see the LICENSE file for details