JobMaster.Api 0.0.5-alpha

Prefix Reserved

This is a prerelease version of JobMaster.Api.

dotnet add package JobMaster.Api --version 0.0.5-alpha

NuGet\Install-Package JobMaster.Api -Version 0.0.5-alpha

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="JobMaster.Api" Version="0.0.5-alpha" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="JobMaster.Api" Version="0.0.5-alpha" />
                    

                            Directory.Packages.props

<PackageReference Include="JobMaster.Api" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add JobMaster.Api --version 0.0.5-alpha

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: JobMaster.Api, 0.0.5-alpha"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package JobMaster.Api@0.0.5-alpha

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=JobMaster.Api&version=0.0.5-alpha&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=JobMaster.Api&version=0.0.5-alpha&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

JobMaster.Api

The JobMaster.Api package transforms your orchestrator into a manageable service. It provides RESTful endpoints to monitor and manage clusters, jobs, and workers.

📦 Installation & NuGet

dotnet add package JobMaster
dotnet add package JobMaster.Api

⚙️ Base Configuration

The API is configured during the service registration phase. You must call app.MapJobMasterApi() after building the app to map the internal routes.

builder.Services.UseJobMasterApi(o =>
{
    o.BasePath = "/jm-api";      // Base route for all JobMaster endpoints
    o.RequireAuthentication = true; // Global toggle for security
    o.EnableSwagger = true;      // Enables isolated Swagger UI
    o.EnableLogging = true;      // Logs API requests to the Cluster Logger
});

var app = builder.Build();

// This maps the endpoints (e.g., /jm-api/my-cluster/jobs)
app.MapJobMasterApi();

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- JobMaster (>= 0.0.5-alpha)
- Microsoft.AspNetCore.OpenApi (>= 8.0.14)
- Microsoft.IdentityModel.JsonWebTokens (>= 8.15.0)
- Swashbuckle.AspNetCore (>= 7.3.1)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.