You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by il...@apache.org on 2016/09/05 15:53:01 UTC

[3/3] cxf git commit: [CXF-7022] Adding general addParameters() method, meant for extension

[CXF-7022] Adding general addParameters() method, meant for extension


Project: http://git-wip-us.apache.org/repos/asf/cxf/repo
Commit: http://git-wip-us.apache.org/repos/asf/cxf/commit/503442f3
Tree: http://git-wip-us.apache.org/repos/asf/cxf/tree/503442f3
Diff: http://git-wip-us.apache.org/repos/asf/cxf/diff/503442f3

Branch: refs/heads/3.0.x-fixes
Commit: 503442f3a33731341fdf58f25d97418d51e0e8ee
Parents: 3649364
Author: Francesco Chicchiricc� <il...@apache.org>
Authored: Mon Sep 5 17:52:17 2016 +0200
Committer: Francesco Chicchiricc� <il...@apache.org>
Committed: Mon Sep 5 17:52:17 2016 +0200

----------------------------------------------------------------------
 .../swagger/DefaultSwagger2Serializers.java     | 22 +++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cxf/blob/503442f3/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/swagger/DefaultSwagger2Serializers.java
----------------------------------------------------------------------
diff --git a/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/swagger/DefaultSwagger2Serializers.java b/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/swagger/DefaultSwagger2Serializers.java
index c30d8bc..d9efb96 100644
--- a/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/swagger/DefaultSwagger2Serializers.java
+++ b/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/swagger/DefaultSwagger2Serializers.java
@@ -49,6 +49,7 @@ import io.swagger.models.Operation;
 import io.swagger.models.Path;
 import io.swagger.models.Swagger;
 import io.swagger.models.Tag;
+import io.swagger.models.parameters.Parameter;
 
 public class DefaultSwagger2Serializers extends SwaggerSerializers implements Swagger2Serializers {
 
@@ -61,6 +62,7 @@ public class DefaultSwagger2Serializers extends SwaggerSerializers implements Sw
     protected List<ClassResourceInfo> cris;
 
     protected BeanConfig beanConfig;
+
     @Override
     public void writeTo(
             final Swagger data,
@@ -128,6 +130,7 @@ public class DefaultSwagger2Serializers extends SwaggerSerializers implements Sw
                             subentry.getValue().getParameters().get(i).
                                     setDescription(javadocProvider.getMethodParameterDoc(ori, i));
                         }
+                        addParameters(subentry.getValue().getParameters());
 
                         if (subentry.getValue().getResponses() != null
                                 && !subentry.getValue().getResponses().isEmpty()) {
@@ -169,6 +172,22 @@ public class DefaultSwagger2Serializers extends SwaggerSerializers implements Sw
         return StringUtils.EMPTY.equals(normalizedPath.toString()) ? "/" : normalizedPath.toString();
     }
 
+    /**
+     * Allows to add parameters to the list, related to an {@link Operation} instance; the method is invoked
+     * for all instances available.
+     *
+     * @param parameters list of parameters defined for an {@link Operation}
+     * @see io.swagger.models.parameters.HeaderParameter
+     * @see io.swagger.models.parameters.CookieParameter
+     * @see io.swagger.models.parameters.PathParameter
+     * @see io.swagger.models.parameters.BodyParameter
+     * @see io.swagger.models.parameters.QueryParameter
+     * @see io.swagger.models.parameters.RefParameter
+     */
+    protected void addParameters(final List<Parameter> parameters) {
+        // does nothing by default
+    }
+
     @Override
     public void setDynamicBasePath(final boolean dynamicBasePath) {
         this.dynamicBasePath = dynamicBasePath;
@@ -182,6 +201,7 @@ public class DefaultSwagger2Serializers extends SwaggerSerializers implements Sw
         this.javadocProvider = javadocProvider;
     }
 
+    @Override
     public void setClassResourceInfos(final List<ClassResourceInfo> classResourceInfos) {
         this.cris = classResourceInfos;
     }
@@ -201,6 +221,6 @@ public class DefaultSwagger2Serializers extends SwaggerSerializers implements Sw
     @Override
     public void setBeanConfig(BeanConfig beanConfig) {
         this.beanConfig = beanConfig;
-        
+
     }
 }