Soenneker.Docker.Hub.OpenApiClient 4.0.20

Soenneker.Docker.Hub.OpenApiClient

A Kiota-generated .NET client for the Docker Hub API.

Installation

dotnet add package Soenneker.Docker.Hub.OpenApiClient

Create a client

using System.Net.Http.Headers;
using Microsoft.Kiota.Abstractions.Authentication;
using Microsoft.Kiota.Http.HttpClientLibrary;
using Soenneker.Docker.Hub.OpenApiClient;

var httpClient = new HttpClient();
httpClient.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", accessToken);

var adapter = new HttpClientRequestAdapter(
    new AnonymousAuthenticationProvider(),
    httpClient: httpClient)
{
    BaseUrl = "https://hub.docker.com"
};

var client = new DockerHubOpenApiClient(adapter);

Keep the token outside source control and reuse the HttpClient, adapter, and generated client. The companion Soenneker.Docker.Hub.OpenApiClientUtil package supplies dependency-injection registration and cached construction.

List personal access tokens

using Soenneker.Docker.Hub.OpenApiClient.Models;

GetAccessTokensResponse? response = await client.V2.AccessTokens.GetAsync(
    request =>
    {
        request.QueryParameters.Page = 1;
        request.QueryParameters.PageSize = 25;
    },
    cancellationToken);

IReadOnlyList<GetAccessTokensResponseResultsItem> tokens = response?.Results ?? [];

Pagination is explicit. Use Next, Previous, and Count from the response to decide which page to request next; the client does not automatically enumerate all results.

API shape and failures

Request builders follow the URL hierarchy, starting at client.V2. Collection indexers supply path parameters, such as an access-token UUID or organization name.

Kiota maps documented non-success responses to generated models deriving from ApiException. The exact error type depends on the endpoint—for example, listing access tokens maps 400 to ValueError and 401 to Error. Preserve those details when logging or translating failures, and let cancellation flow to the caller.

The client and models are generated. Avoid editing them directly because regeneration replaces those changes. Endpoint names, nullability, error mappings, and model shapes can change when Docker Hub’s specification changes; review package updates before upgrading production consumers.