Skip to content

Commit

Permalink
fix: Align modeldefs and Swagger config
Browse files Browse the repository at this point in the history
  • Loading branch information
HofmeisterAn committed Oct 31, 2024
1 parent 3705a40 commit ecec25a
Show file tree
Hide file tree
Showing 11 changed files with 33 additions and 38 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
> [!IMPORTANT]
[![NuGet](https://img.shields.io/nuget/v/Docker.DotNet.Enhanced.svg)](https://www.nuget.org/packages/Docker.DotNet.Enhanced)

> [!IMPORTANT]
> Unfortunately, there has been no further development or bug fixes in [Docker.DotNet](https://github.com/dotnet/Docker.DotNet/tree/aacf3c26131f582ca8acc34084663a4b79e28d38) for some time now, and the repository appears inactive. Reaching the current maintainer is challenging. I understand that priorities shift, and maintaining an open-source project is time-consuming and exhausting. As maintainers, we often cannot dedicate the necessary time. Over the past months—and even years—I have frequently offered my help.
>
>
> Docker.DotNet is an important upstream dependency for Testcontainers for .NET and many other developers. It would be unfortunate for this valuable work not to continue. Therefore, I have decided to fork the repository to focus on essential fixes, improvements, and updates for the Docker Engine API. I am also accepting further contributions and remaining PRs from the upstream repository.
# .NET Client for Docker Remote API
Expand Down
1 change: 0 additions & 1 deletion src/Docker.DotNet.X509/Docker.DotNet.X509.csproj
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<IsPackable>true</IsPackable>
<PackageId>Docker.DotNet.Enhanced.X509</PackageId>
<Description>Docker.DotNet.X509 is a library that allows you to use certificate authentication with a remote Docker engine programmatically in your .NET applications.</Description>
<AssemblyName>Docker.DotNet.X509</AssemblyName>
Expand Down
3 changes: 1 addition & 2 deletions src/Docker.DotNet/Docker.DotNet.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
<AssemblyName>Docker.DotNet</AssemblyName>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
<PackageReference Include="System.Buffers" Version="4.5.1" />
<PackageReference Include="System.Threading.Tasks.Extensions" Version="4.5.4" />
</ItemGroup>
</Project>
12 changes: 3 additions & 9 deletions src/Docker.DotNet/Models/ContainersListParameters.Generated.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,15 @@ namespace Docker.DotNet.Models
[DataContract]
public class ContainersListParameters // (main.ContainersListParameters)
{
[QueryStringParameter("size", false, typeof(BoolQueryStringConverter))]
public bool? Size { get; set; }

[QueryStringParameter("all", false, typeof(BoolQueryStringConverter))]
public bool? All { get; set; }

[QueryStringParameter("since", false)]
public string Since { get; set; }

[QueryStringParameter("before", false)]
public string Before { get; set; }

[QueryStringParameter("limit", false)]
public long? Limit { get; set; }

[QueryStringParameter("size", false, typeof(BoolQueryStringConverter))]
public bool? Size { get; set; }

[QueryStringParameter("filters", false, typeof(MapQueryStringConverter))]
public IDictionary<string, IDictionary<string, bool>> Filters { get; set; }
}
Expand Down
3 changes: 3 additions & 0 deletions src/Docker.DotNet/Models/ImageBuildParameters.Generated.cs
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ public class ImageBuildParameters // (main.ImageBuildParameters)
[QueryStringParameter("outputs", false)]
public string Outputs { get; set; }

[QueryStringParameter("version", false)]
public string Version { get; set; }

[DataMember(Name = "AuthConfigs", EmitDefaultValue = false)]
public IDictionary<string, AuthConfig> AuthConfigs { get; set; }
}
Expand Down
3 changes: 3 additions & 0 deletions src/Docker.DotNet/Models/ImagePushParameters.Generated.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ public class ImagePushParameters // (main.ImagePushParameters)
[QueryStringParameter("tag", false)]
public string Tag { get; set; }

[QueryStringParameter("platform", false)]
public string Platform { get; set; }

[DataMember(Name = "RegistryAuth", EmitDefaultValue = false)]
public AuthConfig RegistryAuth { get; set; }
}
Expand Down
7 changes: 5 additions & 2 deletions src/Docker.DotNet/Models/ImagesListParameters.Generated.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,13 @@ public class ImagesListParameters // (main.ImagesListParameters)
[QueryStringParameter("filters", false, typeof(MapQueryStringConverter))]
public IDictionary<string, IDictionary<string, bool>> Filters { get; set; }

[QueryStringParameter("shared-size", false, typeof(BoolQueryStringConverter))]
public bool? SharedSize { get; set; }

[QueryStringParameter("digests", false, typeof(BoolQueryStringConverter))]
public bool? Digests { get; set; }

[QueryStringParameter("shared-size", false, typeof(BoolQueryStringConverter))]
public bool? SharedSize { get; set; }
[QueryStringParameter("manifests", false, typeof(BoolQueryStringConverter))]
public bool? Manifests { get; set; }
}
}
3 changes: 0 additions & 3 deletions src/Docker.DotNet/Models/ImagesSearchParameters.Generated.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,5 @@ public class ImagesSearchParameters // (main.ImagesSearchParameters)

[QueryStringParameter("filters", false, typeof(MapQueryStringConverter))]
public IDictionary<string, IDictionary<string, bool>> Filters { get; set; }

[DataMember(Name = "RegistryAuth", EmitDefaultValue = false)]
public AuthConfig RegistryAuth { get; set; }
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,5 @@ public class PluginGetPrivilegeParameters // (main.PluginGetPrivilegeParameters)
{
[QueryStringParameter("remote", true)]
public string Remote { get; set; }

[DataMember(Name = "RegistryAuth", EmitDefaultValue = false)]
public AuthConfig RegistryAuth { get; set; }
}
}
1 change: 0 additions & 1 deletion test/Docker.DotNet.Tests/Docker.DotNet.Tests.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
<PackageReference Include="System.ServiceProcess.ServiceController" Version="8.0.1" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" />
<PackageReference Include="xunit" Version="2.9.2" />
</ItemGroup>
Expand Down
29 changes: 14 additions & 15 deletions tools/specgen/modeldefs.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ type ImageBuildParameters struct {
Target string `rest:"query"`
Platform string `rest:"query"`
Outputs string `rest:"query"`
Version string `rest:"query"`
AuthConfigs map[string]registry.AuthConfig `rest:"headers,X-Registry-Config"`
}

Expand Down Expand Up @@ -67,12 +68,10 @@ type CreateContainerParameters struct {

// ContainersListParameters for GET /containers/json
type ContainersListParameters struct {
Size bool `rest:"query"`
All bool `rest:"query"`
Since string `rest:"query"`
Before string `rest:"query"`
Limit int `rest:"query"`
Filters Args `rest:"query"`
All bool `rest:"query"`
Limit int `rest:"query"`
Size bool `rest:"query"`
Filters Args `rest:"query"`
}

// ContainerRemoveParameters for DELETE /containers/(id)
Expand Down Expand Up @@ -183,13 +182,13 @@ type ContainersPruneParameters struct {
}

// ContainerExecCreateParameters for POST /containers/(id)/exec
type ContainerExecCreateParameters types.ExecConfig
type ContainerExecCreateParameters container.ExecOptions

// ContainerExecCreateResponse for POST /containers/(id)/exec
type ContainerExecCreateResponse types.IDResponse

// ContainerExecStartParameters for POST /exec/(id)/start
type ContainerExecStartParameters types.ExecConfig
type ContainerExecStartParameters container.ExecOptions

// ImagesCreateParameters for POST /images/create
type ImagesCreateParameters struct {
Expand All @@ -207,8 +206,9 @@ type ImagesCreateParameters struct {
type ImagesListParameters struct {
All bool `rest:"query"`
Filters Args `rest:"query"`
Digests bool `rest:"query"`
SharedSize bool `rest:"query,shared-size"`
Digests bool `rest:"query"`
Manifests bool `rest:"query"`
}

// ImageLoadParameters for POST /images/load
Expand All @@ -223,10 +223,9 @@ type ImagesPruneParameters struct {

// ImagesSearchParameters for GET /images/search
type ImagesSearchParameters struct {
Term string `rest:"query"`
Limit int `rest:"query"`
Filters Args `rest:"query"`
RegistryAuth registry.AuthConfig `rest:"headers,X-Registry-Auth"`
Term string `rest:"query"`
Limit int `rest:"query"`
Filters Args `rest:"query"`
}

// ImageDeleteParameters for DELETE /images/(id)
Expand All @@ -238,6 +237,7 @@ type ImageDeleteParameters struct {
// ImagePushParameters for POST /images/(id)/push
type ImagePushParameters struct {
Tag string `rest:"query"`
Platform string `rest:"query"`
RegistryAuth registry.AuthConfig `rest:"headers,X-Registry-Auth"`
}

Expand All @@ -264,8 +264,7 @@ type PluginListParameters struct {

// PluginGetPrivilegeParameters for GET /plugins/privileges
type PluginGetPrivilegeParameters struct {
Remote string `rest:"query,remote,required"`
RegistryAuth registry.AuthConfig `rest:"headers,X-Registry-Auth"`
Remote string `rest:"query,remote,required"`
}

// PluginInstallParameters for POST /plugins/pull
Expand Down

0 comments on commit ecec25a

Please sign in to comment.