-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Go back to swagger in regards to #3376, add cmdline switch to force o…
…penapi
- Loading branch information
Showing
7 changed files
with
283 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
53 changes: 53 additions & 0 deletions
53
ArchiSteamFarm/IPC/Swagger/CustomAttributesSchemaFilter.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| // ---------------------------------------------------------------------------------------------- | ||
| // _ _ _ ____ _ _____ | ||
| // / \ _ __ ___ | |__ (_)/ ___| | |_ ___ __ _ _ __ ___ | ___|__ _ _ __ _ __ ___ | ||
| // / _ \ | '__|/ __|| '_ \ | |\___ \ | __|/ _ \ / _` || '_ ` _ \ | |_ / _` || '__|| '_ ` _ \ | ||
| // / ___ \ | | | (__ | | | || | ___) || |_| __/| (_| || | | | | || _|| (_| || | | | | | | | | ||
| // /_/ \_\|_| \___||_| |_||_||____/ \__|\___| \__,_||_| |_| |_||_| \__,_||_| |_| |_| |_| | ||
| // ---------------------------------------------------------------------------------------------- | ||
| // | | ||
| // Copyright 2015-2025 Łukasz "JustArchi" Domeradzki | ||
| // Contact: [email protected] | ||
| // | | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| using System; | ||
| using System.Reflection; | ||
| using ArchiSteamFarm.IPC.Integration; | ||
| using JetBrains.Annotations; | ||
| using Microsoft.OpenApi.Models; | ||
| using Swashbuckle.AspNetCore.SwaggerGen; | ||
|
|
||
| namespace ArchiSteamFarm.IPC.Swagger; | ||
|
|
||
| [UsedImplicitly] | ||
| internal sealed class CustomAttributesSchemaFilter : ISchemaFilter { | ||
| public void Apply(OpenApiSchema schema, SchemaFilterContext context) { | ||
| ArgumentNullException.ThrowIfNull(schema); | ||
| ArgumentNullException.ThrowIfNull(context); | ||
|
|
||
| ICustomAttributeProvider attributesProvider; | ||
|
|
||
| if (context.MemberInfo != null) { | ||
| attributesProvider = context.MemberInfo; | ||
| } else if (context.ParameterInfo != null) { | ||
| attributesProvider = context.ParameterInfo; | ||
| } else { | ||
| return; | ||
| } | ||
|
|
||
| foreach (CustomSwaggerAttribute customSwaggerAttribute in attributesProvider.GetCustomAttributes(typeof(CustomSwaggerAttribute), true)) { | ||
| customSwaggerAttribute.Apply(schema); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| // ---------------------------------------------------------------------------------------------- | ||
| // _ _ _ ____ _ _____ | ||
| // / \ _ __ ___ | |__ (_)/ ___| | |_ ___ __ _ _ __ ___ | ___|__ _ _ __ _ __ ___ | ||
| // / _ \ | '__|/ __|| '_ \ | |\___ \ | __|/ _ \ / _` || '_ ` _ \ | |_ / _` || '__|| '_ ` _ \ | ||
| // / ___ \ | | | (__ | | | || | ___) || |_| __/| (_| || | | | | || _|| (_| || | | | | | | | | ||
| // /_/ \_\|_| \___||_| |_||_||____/ \__|\___| \__,_||_| |_| |_||_| \__,_||_| |_| |_| |_| | ||
| // ---------------------------------------------------------------------------------------------- | ||
| // | | ||
| // Copyright 2015-2025 Łukasz "JustArchi" Domeradzki | ||
| // Contact: [email protected] | ||
| // | | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| using System; | ||
| using System.Globalization; | ||
| using JetBrains.Annotations; | ||
| using Microsoft.OpenApi.Any; | ||
| using Microsoft.OpenApi.Extensions; | ||
| using Microsoft.OpenApi.Models; | ||
| using Swashbuckle.AspNetCore.SwaggerGen; | ||
|
|
||
| namespace ArchiSteamFarm.IPC.Swagger; | ||
|
|
||
| [UsedImplicitly] | ||
| internal sealed class EnumSchemaFilter : ISchemaFilter { | ||
| public void Apply(OpenApiSchema schema, SchemaFilterContext context) { | ||
| ArgumentNullException.ThrowIfNull(schema); | ||
| ArgumentNullException.ThrowIfNull(context); | ||
|
|
||
| if (context.Type is not { IsEnum: true }) { | ||
| return; | ||
| } | ||
|
|
||
| if (context.Type.IsDefined(typeof(FlagsAttribute), false)) { | ||
| schema.Format = "flags"; | ||
| } | ||
|
|
||
| OpenApiObject definition = new(); | ||
|
|
||
| foreach (object? enumValue in context.Type.GetEnumValues()) { | ||
| if (enumValue == null) { | ||
| throw new InvalidOperationException(nameof(enumValue)); | ||
| } | ||
|
|
||
| string? enumName = Enum.GetName(context.Type, enumValue); | ||
|
|
||
| if (string.IsNullOrEmpty(enumName)) { | ||
| // Fallback | ||
| enumName = enumValue.ToString(); | ||
|
|
||
| if (string.IsNullOrEmpty(enumName)) { | ||
| throw new InvalidOperationException(nameof(enumName)); | ||
| } | ||
| } | ||
|
|
||
| if (definition.ContainsKey(enumName)) { | ||
| // This is possible if we have multiple names for the same enum value, we'll ignore additional ones | ||
| continue; | ||
| } | ||
|
|
||
| IOpenApiPrimitive enumObject; | ||
|
|
||
| if (TryCast(enumValue, out int intValue)) { | ||
| enumObject = new OpenApiInteger(intValue); | ||
| } else if (TryCast(enumValue, out long longValue)) { | ||
| enumObject = new OpenApiLong(longValue); | ||
| } else if (TryCast(enumValue, out ulong ulongValue)) { | ||
| // OpenApi spec doesn't support ulongs as of now | ||
| enumObject = new OpenApiString(ulongValue.ToString(CultureInfo.InvariantCulture)); | ||
| } else { | ||
| throw new InvalidOperationException(nameof(enumValue)); | ||
| } | ||
|
|
||
| definition.Add(enumName, enumObject); | ||
| } | ||
|
|
||
| schema.AddExtension("x-definition", definition); | ||
| } | ||
|
|
||
| private static bool TryCast<T>(object value, out T typedValue) where T : struct { | ||
| ArgumentNullException.ThrowIfNull(value); | ||
|
|
||
| try { | ||
| typedValue = (T) Convert.ChangeType(value, typeof(T), CultureInfo.InvariantCulture); | ||
|
|
||
| return true; | ||
| } catch (InvalidCastException) { | ||
| typedValue = default(T); | ||
|
|
||
| return false; | ||
| } catch (OverflowException) { | ||
| typedValue = default(T); | ||
|
|
||
| return false; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| // ---------------------------------------------------------------------------------------------- | ||
| // _ _ _ ____ _ _____ | ||
| // / \ _ __ ___ | |__ (_)/ ___| | |_ ___ __ _ _ __ ___ | ___|__ _ _ __ _ __ ___ | ||
| // / _ \ | '__|/ __|| '_ \ | |\___ \ | __|/ _ \ / _` || '_ ` _ \ | |_ / _` || '__|| '_ ` _ \ | ||
| // / ___ \ | | | (__ | | | || | ___) || |_| __/| (_| || | | | | || _|| (_| || | | | | | | | | ||
| // /_/ \_\|_| \___||_| |_||_||____/ \__|\___| \__,_||_| |_| |_||_| \__,_||_| |_| |_| |_| | ||
| // ---------------------------------------------------------------------------------------------- | ||
| // | | ||
| // Copyright 2015-2025 Łukasz "JustArchi" Domeradzki | ||
| // Contact: [email protected] | ||
| // | | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| using System; | ||
| using System.Reflection; | ||
| using JetBrains.Annotations; | ||
| using Microsoft.OpenApi.Models; | ||
| using Swashbuckle.AspNetCore.SwaggerGen; | ||
|
|
||
| namespace ArchiSteamFarm.IPC.Swagger; | ||
|
|
||
| [UsedImplicitly] | ||
| internal sealed class ReadOnlyFixesSchemaFilter : ISchemaFilter { | ||
| public void Apply(OpenApiSchema schema, SchemaFilterContext context) { | ||
| ArgumentNullException.ThrowIfNull(schema); | ||
| ArgumentNullException.ThrowIfNull(context); | ||
|
|
||
| if (schema.ReadOnly && context.MemberInfo is PropertyInfo { CanWrite: true }) { | ||
| schema.ReadOnly = false; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters