Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

added OpenAPI schema for route parameters #138

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

added OpenAPI schema for route parameters #138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 42 additions & 12 deletions Source/FunctionMonkey.Compiler.Core/Implementation/OpenApi/OpenApiCompiler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,22 +341,52 @@ private static void CreateOperationsFromRoutes(
});
}

foreach (HttpParameter property in functionByRoute.RouteParameters)
if (functionByRoute.RouteParameters.Any())
{
var parameter = new OpenApiParameter
var schema = registry.GetOrCreateSchema(commandType);
foreach (HttpParameter property in functionByRoute.RouteParameters)
{
Name = property.RouteName.ToCamelCase(),
In = ParameterLocation.Path,
Required = !property.IsOptional,
Schema = property.Type.MapToOpenApiSchema(),
Description = ""
};
var propertyInfo = commandType.GetProperty(property.Name);

FilterParameter(compilerConfiguration.ParameterFilters, parameter);
// Property Name
var propertyName = propertyInfo.GetAttributeValue((JsonPropertyAttribute attribute) => attribute.PropertyName);
if (string.IsNullOrWhiteSpace(propertyName))
{
propertyName = propertyInfo.GetAttributeValue((DataMemberAttribute attribute) => attribute.Name);
}
if (string.IsNullOrWhiteSpace(propertyName))
{
propertyName = propertyInfo.Name.ToCamelCase();
}

operation.Parameters.Add(parameter);
// TODO: We need to consider what to do with the payload model here - if its a route parameter
// we need to ignore it in the payload model
// Property Required
var propertyRequired = !property.IsOptional;
if (!propertyRequired)
{
propertyRequired = propertyInfo.GetAttributeValue((JsonPropertyAttribute attribute) => attribute.Required) == Required.Always;
}
if (!propertyRequired)
{
propertyRequired = propertyInfo.GetAttributeValue((RequiredAttribute attribute) => attribute) != null;
}

var propertySchema = schema.Properties[propertyName];

var parameter = new OpenApiParameter
{
Name = property.RouteName.ToCamelCase(),
In = ParameterLocation.Path,
Required = propertyRequired,
Schema = propertySchema,
Description = propertySchema.Description
};

FilterParameter(compilerConfiguration.ParameterFilters, parameter);

operation.Parameters.Add(parameter);
// TODO: We need to consider what to do with the payload model here - if its a route parameter
// we need to ignore it in the payload model
}
}

if (method == HttpMethod.Post || method == HttpMethod.Put || method == HttpMethod.Patch)
Expand Down