Upgrading Swashbuckle.AspNetCore.SwaggerUI 1 to 2
Unknown1.2.0 → 2.5.0
Fetching 7 releases from GitHub…0 / 7
UnknownUpgrade verdict
DepDelta is still reading the notes for this range, so breaking changes can't be ruled out yet.
In plain terms
- DepDelta is still reading the release notes in this range, so it can't rule out breaking changes yet.
- This page updates as the notes come in.
Must act Still reading release notes
DepDelta is still reading the release notes in this range. This updates as they come in.
API changes
Generated by DepDelta from published .NET assemblies. Not mixed with prose notes.
- changed:
static method SwaggerUIBuilderExtensions.UseSwaggerUI(IApplicationBuilder app, Action<SwaggerUIOptions> setupAction): IApplicationBuilder → static method SwaggerUIBuilderExtensions.UseSwaggerUI(IApplicationBuilder app, Action<SwaggerUIOptions> setupAction = …): IApplicationBuilder - added:
enum DocExpansion - added:
enum ModelRendering - added:
enum SubmitMethod - added:
member DocExpansion.Full - added:
member DocExpansion.List - added:
member DocExpansion.None - added:
member ModelRendering.Example - added:
member ModelRendering.Model - added:
member SubmitMethod.Delete - added:
member SubmitMethod.Get - added:
member SubmitMethod.Head - added:
member SubmitMethod.Options - added:
member SubmitMethod.Patch - added:
member SubmitMethod.Post - added:
member SubmitMethod.Put - added:
member SubmitMethod.Trace - added:
static class SwaggerUIOptionsExtensions - added:
static method SwaggerUIOptionsExtensions.DefaultModelExpandDepth(SwaggerUIOptions options, int depth): void - added:
static method SwaggerUIOptionsExtensions.DefaultModelRendering(SwaggerUIOptions options, ModelRendering modelRendering): void - added:
static method SwaggerUIOptionsExtensions.DefaultModelsExpandDepth(SwaggerUIOptions options, int depth): void - added:
static method SwaggerUIOptionsExtensions.DisplayOperationId(SwaggerUIOptions options): void - added:
static method SwaggerUIOptionsExtensions.DisplayRequestDuration(SwaggerUIOptions options): void - added:
static method SwaggerUIOptionsExtensions.DocExpansion(SwaggerUIOptions options, DocExpansion docExpansion): void - added:
static method SwaggerUIOptionsExtensions.EnableDeepLinking(SwaggerUIOptions options): void - added:
static method SwaggerUIOptionsExtensions.EnableFilter(SwaggerUIOptions options, string expression = …): void - added:
static method SwaggerUIOptionsExtensions.EnableValidator(SwaggerUIOptions options, string url = …): void - added:
static method SwaggerUIOptionsExtensions.InjectStylesheet(SwaggerUIOptions options, string path, string media = …): void - added:
static method SwaggerUIOptionsExtensions.MaxDisplayedTags(SwaggerUIOptions options, int count): void - added:
static method SwaggerUIOptionsExtensions.OAuth2RedirectUrl(SwaggerUIOptions options, string url): void - added:
static method SwaggerUIOptionsExtensions.OAuthAdditionalQueryStringParams(SwaggerUIOptions options, object value): void - added:
static method SwaggerUIOptionsExtensions.OAuthAppName(SwaggerUIOptions options, string value): void - added:
static method SwaggerUIOptionsExtensions.OAuthClientId(SwaggerUIOptions options, string value): void - added:
static method SwaggerUIOptionsExtensions.OAuthClientSecret(SwaggerUIOptions options, string value): void - added:
static method SwaggerUIOptionsExtensions.OAuthRealm(SwaggerUIOptions options, string value): void - added:
static method SwaggerUIOptionsExtensions.OAuthScopeSeparator(SwaggerUIOptions options, string value): void - added:
static method SwaggerUIOptionsExtensions.OAuthUseBasicAuthenticationWithAccessCodeGrant(SwaggerUIOptions options): void - added:
static method SwaggerUIOptionsExtensions.ShowExtensions(SwaggerUIOptions options): void - added:
static method SwaggerUIOptionsExtensions.SupportedSubmitMethods(SwaggerUIOptions options, SubmitMethod[] submitMethods): void - added:
static method SwaggerUIOptionsExtensions.SwaggerEndpoint(SwaggerUIOptions options, string url, string name): void - added:
static method SwaggerUIOptionsExtensions.ValidatorUrl(SwaggerUIOptions options, string url): void
- removed:
class EndpointDescriptor - removed:
class IndexSettings - removed:
class JSConfig - removed:
class StylesheetDescriptor - removed:
ctor EndpointDescriptor() - removed:
ctor IndexSettings() - removed:
ctor JSConfig() - removed:
ctor StylesheetDescriptor() - removed:
method IndexSettings.ToTemplateParameters(): IDictionary<string, string> - removed:
method SwaggerUIOptions.BooleanValues(object[] values): void - removed:
method SwaggerUIOptions.ConfigureOAuth2(string clientId, string clientSecret, string realm, string appName, string scopeSeparator = …, object additionalQueryStringParameters = …): void - removed:
method SwaggerUIOptions.DocExpansion(string value): void - removed:
method SwaggerUIOptions.DocumentTitle(string value): void - removed:
method SwaggerUIOptions.EnabledValidator(string validatorUrl = …): void - removed:
method SwaggerUIOptions.InjectJavaScript(string path): void - removed:
method SwaggerUIOptions.InjectOnCompleteJavaScript(string path): void - removed:
method SwaggerUIOptions.InjectOnFailureJavaScript(string path): void - removed:
method SwaggerUIOptions.InjectStylesheet(string path, string media = …): void - removed:
method SwaggerUIOptions.ShowJsonEditor(): void - removed:
method SwaggerUIOptions.ShowRequestHeaders(): void - removed:
method SwaggerUIOptions.SupportedSubmitMethods(string[] supportedSubmitMethods): void - removed:
method SwaggerUIOptions.SwaggerEndpoint(string url, string description): void - removed:
property EndpointDescriptor.Description: string { get; set; } - removed:
property EndpointDescriptor.Url: string { get; set; } - removed:
property IndexSettings.DocTitle: string { get; set; } - removed:
property IndexSettings.JSConfig: JSConfig { get; } - removed:
property IndexSettings.Stylesheets: IList<StylesheetDescriptor> { get; } - removed:
property JSConfig.BooleanValues: object[] { get; set; } - removed:
property JSConfig.DocExpansion: string { get; set; } - removed:
property JSConfig.JsonEditor: bool { get; set; } - removed:
property JSConfig.OAuth2AdditionalQueryStringParams: object { get; set; } - removed:
property JSConfig.OAuth2AppName: string { get; set; } - removed:
property JSConfig.OAuth2ClientId: string { get; set; } - removed:
property JSConfig.OAuth2ClientSecret: string { get; set; } - removed:
property JSConfig.OAuth2Realm: string { get; set; } - removed:
property JSConfig.OAuth2ScopeSeparator: string { get; set; } - removed:
property JSConfig.OnCompleteScripts: IList<string> { get; } - removed:
property JSConfig.OnFailureScripts: IList<string> { get; } - removed:
property JSConfig.ShowRequestHeaders: bool { get; set; } - removed:
property JSConfig.SupportedSubmitMethods: string[] { get; set; } - removed:
property JSConfig.SwaggerEndpoints: IList<EndpointDescriptor> { get; } - removed:
property JSConfig.ValidatorUrl: string { get; set; } - removed:
property StylesheetDescriptor.Href: string { get; set; } - removed:
property StylesheetDescriptor.Media: string { get; set; } - added:
property SwaggerUIOptions.ConfigObject: JObject { get; } - added:
property SwaggerUIOptions.DocumentTitle: string { get; set; } - added:
property SwaggerUIOptions.HeadContent: string { get; set; } - added:
property SwaggerUIOptions.OAuthConfigObject: JObject { get; }