@Override public Optional<Parameter> filterParameter(Parameter parameter, Operation operation, ApiDescription api, Map<String, List<String>> params, Map<String, String> cookies, Map<String, List<String>> headers) { if (QUERY_IN.equals(parameter.getIn())) { return Optional.empty(); } return Optional.of(parameter); } }
private void validateParameters(Operation operation) { if (operation != null) { for (Parameter parameter : operation.getParameters()) { assertNotEquals(QUERY, parameter.getIn()); } } }
ResolvedParameter extractParametersResult = new ResolvedParameter(); if (parameter != null && (StringUtils.isNotBlank(parameter.getIn()) || StringUtils.isNotBlank(parameter.get$ref()))) { parameters.add(parameter); } else if (includeRequestBody) { methodConsumes == null ? new String[0] : methodConsumes.value(), jsonViewAnnotation); if (unknownParameter != null) { if (StringUtils.isNotBlank(unknownParameter.getIn()) && !"form".equals(unknownParameter.getIn())) { extractParametersResult.parameters.add(unknownParameter); } else if ("form".equals(unknownParameter.getIn())) { unknownParameter.setIn(null); extractParametersResult.formParameters.add(unknownParameter);
/** * Filter parameters to display in parameters section * * @param parameter parameter to filter * @return true if parameter can be displayed */ private boolean filterParameter(Parameter parameter) { return (!config.isFlatBodyEnabled() || !StringUtils.equals(parameter.getIn(), "body")); }
public void removePathParameter(String name, List<Parameter> parameters) { parameters .stream() .filter(p -> "path".equals(p.getIn()) && name.equals(p.getName())) .findFirst() .ifPresent(parameters::remove); } }
public String getIn() { return WordUtils.capitalize(parameter.getIn()); }
private boolean isPathParamDefined(String pathParam, List<Parameter> parameters) { if (parameters == null || parameters.isEmpty()) { return false; } else { Parameter pathParamDefined = parameters.stream() .filter(parameter -> pathParam.equals(parameter.getName()) && "path".equals(parameter.getIn())) .findFirst() .orElse(null); if (pathParamDefined == null) { return false; } } return true; }
private String itemParam(String title, Parameter param) { StringBuilder sb = new StringBuilder(""); sb.append(StringUtils.repeat(' ', 4)) .append("- ") .append(title) .append(param.getName()) .append(" in ") .append(param.getIn()) .append(System.lineSeparator()); // .append(null == param.getDescription() ? "" // : (" //" + param.getDescription())); return sb.toString(); }
private boolean isPathParamDefined(String pathParam, List<Parameter> parameters) { if (parameters == null || parameters.isEmpty()) { return false; } else { Parameter pathParamDefined = parameters.stream() .filter(parameter -> pathParam.equals(parameter.getName()) && "path".equals(parameter.getIn())) .findFirst() .orElse(null); if (pathParamDefined == null) { return false; } } return true; }
private boolean isPathParamDefined(String pathParam, List<Parameter> parameters) { if (parameters == null || parameters.isEmpty()) { return false; } else { Parameter pathParamDefined = parameters.stream() .filter(parameter -> pathParam.equals(parameter.getName()) && "path".equals(parameter.getIn())) .findFirst() .orElse(null); if (pathParamDefined == null) { return false; } } return true; }
private static String generateParameterId(Parameter parameter) { return parameter.getName() + ":" + parameter.getIn(); }
private static String formatContext(@Nullable final ValidationReport.MessageContext ctx) { if (ctx == null) { return ""; } final String ctxString = stream( new String[]{ ctx.getRequestMethod().map(Enum::name).orElse(null), ctx.getRequestPath().orElse(null), ctx.getParameter() .map(p -> "@" + p.getIn() + "." + p.getName()) .orElse(ctx.getApiRequestBodyDefinition().map(b -> "@body").orElse(null)) }) .filter(Objects::nonNull) .collect(joining(" ", "[", "]")); return ctx.getLocation().map(l -> "[" + l.name() + "]").orElse("") + ctxString; }
protected String itemParameter(String title, Parameter parameter) { return this.itemParameter( title, parameter.getName(), parameter.getIn(), parameter.getDescription()); }
protected String itemParameter(ChangedParameter param) { Parameter rightParam = param.getNewParameter(); if (param.isDeprecated()) { return itemParameter( "Deprecated", rightParam.getName(), rightParam.getIn(), rightParam.getDescription()); } return itemParameter( "Changed", rightParam.getName(), rightParam.getIn(), rightParam.getDescription()); }
private ContainerTag li_addParam(Parameter param) { return li().withText("Add " + param.getName() + " in " + param.getIn()) .with( span(null == param.getDescription() ? "" : ("//" + param.getDescription())) .withClass("comment")); }
@Override public RequestParameter transform(Parameter from) { RequestParameterInType inType = requestParameterInTypeResolver.resolve(from.getIn()); String name = from.getName(); boolean required = BooleanUtils.toBoolean(from.getRequired()); Schema swSchema = from.getSchema(); if (swSchema != null) { return new RequestParameter(inType, name, required, schemaTransformer.transform(swSchema)); } return new RequestParameter(inType, name, required); } }
private ContainerTag li_missingParam(Parameter param) { return li().withClass("missing") .with(span("Delete")) .with(del(param.getName())) .with(span("in ").withText(param.getIn())) .with( span(null == param.getDescription() ? "" : ("//" + param.getDescription())) .withClass("comment")); }
@Override public BallerinaParameter buildContext(Parameter parameter, OpenAPI openAPI) throws BallerinaOpenApiException { this.name = parameter.getName(); this.in = parameter.getIn(); this.description = parameter.getDescription(); this.required = parameter.getRequired(); this.deprecated = parameter.getDeprecated(); this.allowEmptyValue = parameter.getAllowEmptyValue(); this.ref = parameter.get$ref(); this.style = parameter.getStyle(); this.explode = parameter.getExplode(); this.allowReserved = parameter.getAllowReserved(); this.examples = parameter.getExamples(); this.example = parameter.getExample(); this.content = parameter.getContent(); this.extensions = parameter.getExtensions(); this.schema = new BallerinaSchema().buildContext(parameter.getSchema(), openAPI); return this; }