From 548708a64a4e0edb9cca3d36201a9d4b7ef3e965 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 18 Mar 2025 08:51:10 +0000 Subject: [PATCH 1/3] Bump version Bump version to 7.3.3 for the next release. --- Directory.Build.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index 97a70375bf..4b891fbba2 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -35,14 +35,14 @@ package-readme.md See $(PackageProjectUrl)/releases for details. false - 7.3.1 + 7.3.2 true git $(PackageProjectUrl).git snupkg true true - 7.3.2 + 7.3.3 false From e2b840ede7ebb9eb0101e34c6a26f70ac384cd40 Mon Sep 17 00:00:00 2001 From: Martin Costello Date: Tue, 18 Mar 2025 08:53:41 +0000 Subject: [PATCH 2/3] Update README Update version table. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5b636066a0..31e3b2a792 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Once you have an API that can describe itself in Swagger, you've opened the trea | Swashbuckle Version | ASP.NET Core | Swagger / OpenAPI Spec. | swagger-ui | Redoc UI | |----------|----------|----------|----------|----------| | [CI](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/commits/master/) | >= 2.0.0 | 2.0, 3.0 | [5.x.x](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/src/Swashbuckle.AspNetCore.SwaggerUI/package.json#L6) | [2.x.x](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/src/Swashbuckle.AspNetCore.ReDoc/package.json#L6) | -| [7.3.1](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/tree/v7.2.0) | >= 2.0.0 | 2.0, 3.0 | 5.20.0 | 2.4.0 | +| [7.3.2](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/tree/v7.3.2) | >= 2.0.0 | 2.0, 3.0 | 5.20.1 | 2.4.0 | | [6.9.0](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/tree/v6.9.0) | >= 2.0.0 | 2.0, 3.0 | 5.17.14 | 2.1.5 | | [5.6.3](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/tree/v5.6.3) | >= 2.0.0 | 2.0, 3.0 | 3.32.5 | 2.0.0-rc.40 | | [4.0.0](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/tree/v4.0.0) | >= 2.0.0, < 3.0.0 | 2.0 | 3.19.5 | 1.22.2 | From fe8f550581e8b5c9654c7788cd04500e5bf1215b Mon Sep 17 00:00:00 2001 From: martincostello Date: Tue, 18 Mar 2025 08:59:47 +0000 Subject: [PATCH 3/3] Update Public API baselines Move Unshipped APIs to Shipped. --- .../PublicAPI/PublicAPI.Shipped.txt | 2 ++ .../PublicAPI/PublicAPI.Unshipped.txt | 2 -- .../PublicAPI/PublicAPI.Shipped.txt | 5 +++++ .../PublicAPI/PublicAPI.Unshipped.txt | 5 ----- .../PublicAPI/PublicAPI.Shipped.txt | 5 +++++ .../PublicAPI/PublicAPI.Unshipped.txt | 5 ----- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/Swashbuckle.AspNetCore.Swagger/PublicAPI/PublicAPI.Shipped.txt b/src/Swashbuckle.AspNetCore.Swagger/PublicAPI/PublicAPI.Shipped.txt index 5252affd44..0b8e3fa25f 100644 --- a/src/Swashbuckle.AspNetCore.Swagger/PublicAPI/PublicAPI.Shipped.txt +++ b/src/Swashbuckle.AspNetCore.Swagger/PublicAPI/PublicAPI.Shipped.txt @@ -11,6 +11,8 @@ Swashbuckle.AspNetCore.Swagger.ISwaggerDocumentSerializer Swashbuckle.AspNetCore.Swagger.ISwaggerDocumentSerializer.SerializeDocument(Microsoft.OpenApi.Models.OpenApiDocument document, Microsoft.OpenApi.Writers.IOpenApiWriter writer, Microsoft.OpenApi.OpenApiSpecVersion specVersion) -> void Swashbuckle.AspNetCore.Swagger.ISwaggerProvider Swashbuckle.AspNetCore.Swagger.ISwaggerProvider.GetSwagger(string documentName, string host = null, string basePath = null) -> Microsoft.OpenApi.Models.OpenApiDocument +Swashbuckle.AspNetCore.Swagger.ISwaggerDocumentMetadataProvider +Swashbuckle.AspNetCore.Swagger.ISwaggerDocumentMetadataProvider.GetDocumentNames() -> System.Collections.Generic.IList Swashbuckle.AspNetCore.Swagger.SwaggerEndpointOptions Swashbuckle.AspNetCore.Swagger.SwaggerEndpointOptions.PreSerializeFilters.get -> System.Collections.Generic.List> Swashbuckle.AspNetCore.Swagger.SwaggerEndpointOptions.SerializeAsV2.get -> bool diff --git a/src/Swashbuckle.AspNetCore.Swagger/PublicAPI/PublicAPI.Unshipped.txt b/src/Swashbuckle.AspNetCore.Swagger/PublicAPI/PublicAPI.Unshipped.txt index 97812dd87b..e69de29bb2 100644 --- a/src/Swashbuckle.AspNetCore.Swagger/PublicAPI/PublicAPI.Unshipped.txt +++ b/src/Swashbuckle.AspNetCore.Swagger/PublicAPI/PublicAPI.Unshipped.txt @@ -1,2 +0,0 @@ -Swashbuckle.AspNetCore.Swagger.ISwaggerDocumentMetadataProvider -Swashbuckle.AspNetCore.Swagger.ISwaggerDocumentMetadataProvider.GetDocumentNames() -> System.Collections.Generic.IList diff --git a/src/Swashbuckle.AspNetCore.SwaggerGen/PublicAPI/PublicAPI.Shipped.txt b/src/Swashbuckle.AspNetCore.SwaggerGen/PublicAPI/PublicAPI.Shipped.txt index 695cbeb8bd..afccb33a83 100644 --- a/src/Swashbuckle.AspNetCore.SwaggerGen/PublicAPI/PublicAPI.Shipped.txt +++ b/src/Swashbuckle.AspNetCore.SwaggerGen/PublicAPI/PublicAPI.Shipped.txt @@ -69,6 +69,7 @@ static Swashbuckle.AspNetCore.SwaggerGen.MemberInfoExtensions.IsDictionaryValueN static Swashbuckle.AspNetCore.SwaggerGen.MemberInfoExtensions.IsNonNullableReferenceType(this System.Reflection.MemberInfo memberInfo) -> bool static Swashbuckle.AspNetCore.SwaggerGen.MethodInfoExtensions.GetUnderlyingGenericTypeMethod(this System.Reflection.MethodInfo constructedTypeMethod) -> System.Reflection.MethodInfo static Swashbuckle.AspNetCore.SwaggerGen.OpenApiAnyFactory.CreateFromJson(string json) -> Microsoft.OpenApi.Any.IOpenApiAny +static Swashbuckle.AspNetCore.SwaggerGen.OpenApiAnyFactory.CreateFromJson(string json, System.Text.Json.JsonSerializerOptions options) -> Microsoft.OpenApi.Any.IOpenApiAny static Swashbuckle.AspNetCore.SwaggerGen.OpenApiSchemaExtensions.ApplyRouteConstraints(this Microsoft.OpenApi.Models.OpenApiSchema schema, Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo routeInfo) -> void static Swashbuckle.AspNetCore.SwaggerGen.OpenApiSchemaExtensions.ApplyValidationAttributes(this Microsoft.OpenApi.Models.OpenApiSchema schema, System.Collections.Generic.IEnumerable customAttributes) -> void static Swashbuckle.AspNetCore.SwaggerGen.OpenApiSchemaExtensions.ResolveType(this Microsoft.OpenApi.Models.OpenApiSchema schema, Swashbuckle.AspNetCore.SwaggerGen.SchemaRepository schemaRepository) -> string @@ -86,6 +87,7 @@ static Swashbuckle.AspNetCore.SwaggerGen.XmlCommentsNodeNameHelper.GetMemberName static Swashbuckle.AspNetCore.SwaggerGen.XmlCommentsNodeNameHelper.GetMemberNameForMethod(System.Reflection.MethodInfo method) -> string static Swashbuckle.AspNetCore.SwaggerGen.XmlCommentsNodeNameHelper.GetMemberNameForType(System.Type type) -> string static Swashbuckle.AspNetCore.SwaggerGen.XmlCommentsTextHelper.Humanize(string text) -> string +static Swashbuckle.AspNetCore.SwaggerGen.XmlCommentsTextHelper.Humanize(string text, string xmlCommentEndOfLine) -> string Swashbuckle.AspNetCore.Annotations.SwaggerIgnoreAttribute Swashbuckle.AspNetCore.Annotations.SwaggerIgnoreAttribute.SwaggerIgnoreAttribute() -> void Swashbuckle.AspNetCore.SwaggerGen.ApiDescriptionExtensions @@ -242,6 +244,7 @@ Swashbuckle.AspNetCore.SwaggerGen.SwaggerApplicationConvention Swashbuckle.AspNetCore.SwaggerGen.SwaggerApplicationConvention.Apply(Microsoft.AspNetCore.Mvc.ApplicationModels.ApplicationModel application) -> void Swashbuckle.AspNetCore.SwaggerGen.SwaggerApplicationConvention.SwaggerApplicationConvention() -> void Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator +Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.GetDocumentNames() -> System.Collections.Generic.IList Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.GetSwagger(string documentName, string host = null, string basePath = null) -> Microsoft.OpenApi.Models.OpenApiDocument Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.GetSwaggerAsync(string documentName, string host = null, string basePath = null) -> System.Threading.Tasks.Task Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.SwaggerGenerator(Swashbuckle.AspNetCore.SwaggerGen.SwaggerGeneratorOptions options, Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionGroupCollectionProvider apiDescriptionsProvider, Swashbuckle.AspNetCore.SwaggerGen.ISchemaGenerator schemaGenerator) -> void @@ -297,6 +300,8 @@ Swashbuckle.AspNetCore.SwaggerGen.SwaggerGeneratorOptions.SwaggerDocs.set -> voi Swashbuckle.AspNetCore.SwaggerGen.SwaggerGeneratorOptions.SwaggerGeneratorOptions() -> void Swashbuckle.AspNetCore.SwaggerGen.SwaggerGeneratorOptions.TagsSelector.get -> System.Func> Swashbuckle.AspNetCore.SwaggerGen.SwaggerGeneratorOptions.TagsSelector.set -> void +Swashbuckle.AspNetCore.SwaggerGen.SwaggerGeneratorOptions.XmlCommentEndOfLine.get -> string +Swashbuckle.AspNetCore.SwaggerGen.SwaggerGeneratorOptions.XmlCommentEndOfLine.set -> void Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions.DocumentFilterDescriptors.get -> System.Collections.Generic.List Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions.DocumentFilterDescriptors.set -> void diff --git a/src/Swashbuckle.AspNetCore.SwaggerGen/PublicAPI/PublicAPI.Unshipped.txt b/src/Swashbuckle.AspNetCore.SwaggerGen/PublicAPI/PublicAPI.Unshipped.txt index 9103c715aa..e69de29bb2 100644 --- a/src/Swashbuckle.AspNetCore.SwaggerGen/PublicAPI/PublicAPI.Unshipped.txt +++ b/src/Swashbuckle.AspNetCore.SwaggerGen/PublicAPI/PublicAPI.Unshipped.txt @@ -1,5 +0,0 @@ -static Swashbuckle.AspNetCore.SwaggerGen.OpenApiAnyFactory.CreateFromJson(string json, System.Text.Json.JsonSerializerOptions options) -> Microsoft.OpenApi.Any.IOpenApiAny -static Swashbuckle.AspNetCore.SwaggerGen.XmlCommentsTextHelper.Humanize(string text, string xmlCommentEndOfLine) -> string -Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.GetDocumentNames() -> System.Collections.Generic.IList -Swashbuckle.AspNetCore.SwaggerGen.SwaggerGeneratorOptions.XmlCommentEndOfLine.get -> string -Swashbuckle.AspNetCore.SwaggerGen.SwaggerGeneratorOptions.XmlCommentEndOfLine.set -> void diff --git a/src/Swashbuckle.AspNetCore.SwaggerUI/PublicAPI/PublicAPI.Shipped.txt b/src/Swashbuckle.AspNetCore.SwaggerUI/PublicAPI/PublicAPI.Shipped.txt index 572eb0f5df..6571a9c116 100644 --- a/src/Swashbuckle.AspNetCore.SwaggerUI/PublicAPI/PublicAPI.Shipped.txt +++ b/src/Swashbuckle.AspNetCore.SwaggerUI/PublicAPI/PublicAPI.Shipped.txt @@ -11,6 +11,7 @@ static Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.DocExpansion(this static Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.EnableDeepLinking(this Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions options) -> void static Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.EnableFilter(this Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions options, string expression = null) -> void static Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.EnablePersistAuthorization(this Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions options) -> void +static Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.EnableSwaggerDocumentUrlsEndpoint(this Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions options) -> void static Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.EnableTryItOutByDefault(this Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions options) -> void static Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.EnableValidator(this Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions options, string url = "https://online.swagger.io/validator") -> void static Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.InjectJavascript(this Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions options, string path, string type = "text/javascript") -> void @@ -123,6 +124,8 @@ Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.ConfigObject.get -> Swashbuckl Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.ConfigObject.set -> void Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.DocumentTitle.get -> string Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.DocumentTitle.set -> void +Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.ExposeSwaggerDocumentUrlsRoute.get -> bool +Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.ExposeSwaggerDocumentUrlsRoute.set -> void Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.HeadContent.get -> string Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.HeadContent.set -> void Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.IndexStream.get -> System.Func @@ -141,6 +144,8 @@ Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.ScriptPresetsPath.get -> strin Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.ScriptPresetsPath.set -> void Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.StylesPath.get -> string Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.StylesPath.set -> void +Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.SwaggerDocumentUrlsPath.get -> string +Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.SwaggerDocumentUrlsPath.set -> void Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.SwaggerUIOptions() -> void Swashbuckle.AspNetCore.SwaggerUI.UrlDescriptor Swashbuckle.AspNetCore.SwaggerUI.UrlDescriptor.Name.get -> string diff --git a/src/Swashbuckle.AspNetCore.SwaggerUI/PublicAPI/PublicAPI.Unshipped.txt b/src/Swashbuckle.AspNetCore.SwaggerUI/PublicAPI/PublicAPI.Unshipped.txt index 974e583fc9..e69de29bb2 100644 --- a/src/Swashbuckle.AspNetCore.SwaggerUI/PublicAPI/PublicAPI.Unshipped.txt +++ b/src/Swashbuckle.AspNetCore.SwaggerUI/PublicAPI/PublicAPI.Unshipped.txt @@ -1,5 +0,0 @@ -static Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.EnableSwaggerDocumentUrlsEndpoint(this Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions options) -> void -Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.ExposeSwaggerDocumentUrlsRoute.get -> bool -Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.ExposeSwaggerDocumentUrlsRoute.set -> void -Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.SwaggerDocumentUrlsPath.get -> string -Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.SwaggerDocumentUrlsPath.set -> void