protected static void processApiParam(ApiParam param, BodyParameter p) { if (param.required()) { p.setRequired(true); } if (StringUtils.isNotEmpty(param.name())) { p.setName(param.name()); } if (StringUtils.isNotEmpty(param.value())) { p.setDescription(param.value()); } if (StringUtils.isNotEmpty(param.access())) { p.setAccess(param.access()); } Example example = param.examples(); if (example != null && example.value() != null) { for (ExampleProperty ex : example.value()) { String mediaType = ex.mediaType(); String value = ex.value(); if (!mediaType.isEmpty() && !value.isEmpty()) { p.example(mediaType.trim(), value.trim()); } } } }
public BodyParameter description(String description) { this.setDescription(description); return this; }
private BodyParameter getDefaultBodyParameter() { BodyParameter bodyParameter = new BodyParameter(); bodyParameter.setName("Payload"); bodyParameter.setDescription("Request Body"); bodyParameter.setRequired(false); Model model = new ModelImpl(); Map<String, Property> properties = new HashMap<>(); Property property = new StringProperty(); properties.put("payload", property); model.setProperties(properties); bodyParameter.setSchema(model); return bodyParameter; }
private BodyParameter getDefaultBodyParameter() { BodyParameter bodyParameter = new BodyParameter(); bodyParameter.setName("Payload"); bodyParameter.setDescription("Request Body"); bodyParameter.setRequired(false); Model model = new ModelImpl(); Map<String, Property> properties = new HashMap<>(); Property property = new StringProperty(); properties.put("payload", property); model.setProperties(properties); bodyParameter.setSchema(model); return bodyParameter; }
private Parameter buildPOSTBodyParameter(String resourceName, String resourceParentName, OperationEnum operationEnum) { BodyParameter bodyParameter = new BodyParameter(); bodyParameter.setRequired(true); switch (operationEnum) { case postCreate: case postSubresource: bodyParameter.setName("resource"); bodyParameter.setDescription("Resource to create"); break; case postUpdate: case postUpdateSubresouce: bodyParameter.setName("resource"); bodyParameter.setDescription("Resource properties to update"); } bodyParameter.schema(new RefModel(getSchemaRef(resourceName, resourceParentName, operationEnum))); return bodyParameter; }
protected static void processApiParam(ApiParam param, BodyParameter p) { if (param.required()) { p.setRequired(true); } if (StringUtils.isNotEmpty(param.name())) { p.setName(param.name()); } if (StringUtils.isNotEmpty(param.value())) { p.setDescription(param.value()); } if (StringUtils.isNotEmpty(param.access())) { p.setAccess(param.access()); } Example example = param.examples(); if (example != null && example.value() != null) { for (ExampleProperty ex : example.value()) { String mediaType = ex.mediaType(); String value = ex.value(); if (!mediaType.isEmpty() && !value.isEmpty()) { p.example(mediaType.trim(), value.trim()); } } } }
bp.setName("body"); bp.setDescription(param.value());
bp.setDescription(param.getDescription());
operation.addParameter(param); param.setName(requestTypeName); param.setDescription("Request body"); param.setDescription(this.getMessageDocumentation(method.getRequest())); param.setSchema(this.getReferenceToType(requestTypeName)); this.setVendorExtensions(method.getRequest(), param);
bodyParameter.setDescription(getDescription(methodParameter)); bodyParameter.setRequired(true);
bodyParameter.setDescription(getDescription(methodParameter)); bodyParameter.setRequired(true);
parameter.setDescription(apiParam.value());