Merge pull request #1 from Ouest-France/add-bloctype-documentation

feat(blocktype): add documentation entry

README.adoc

@@ -18,7 +18,7 @@ You simply need to generate the object and let your favorite JSON framework seri
 <dependency>
     <groupId>io.github.ouest-france</groupId>
     <artifactId>bp-contract-generator</artifactId>
-    <version>1.0.0</version>
+    <version>1.0.2</version>
 </dependency>
 ```
 
@@ -42,6 +42,9 @@ public class BlockProviderResource {
                         // the block type
                         .addType("bold").withVersion(1, 0, 0)
 
+                        // set documentation
+                        .withDocumentation("http://ww.google.fr")
+
                         // declare the endpoint url
                         .withEndpoint("https://localhost/block-configurations", "GET", "pure")
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.ouest-france</groupId>
     <artifactId>bp-contract-generator</artifactId>
-    <version>1.0.1-SANPASHOT</version>
+    <version>1.0.2</version>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

src/main/java/sipa/blockprovider/BlockTypeBuilder.java

@@ -70,6 +70,17 @@ public BlockTypeBuilder withVersion(final int major, final int minor, final int
         return this;
     }
 
+    /**
+     * Set the version of the block type.
+     *
+     * @param url external documentation url
+     * @return the block type builder
+     */
+    public BlockTypeBuilder withDocumentation(final String url) {
+        this.blockConfiguration.setDocumentation(url);
+        return this;
+    }
+
     /**
      * Specify the endpoint settings associated with the block type.
      *

src/main/java/sipa/blockprovider/domain/BlockConfiguration.java

@@ -9,6 +9,7 @@
 public class BlockConfiguration {
 
     private String version;
+    private final Documentation documentation = new Documentation();
     private final Endpoint endpoint = new Endpoint();
     private final List<Template> templates = new ArrayList<>();
 
@@ -27,4 +28,14 @@ public void setVersion(final String version) {
     public List<Template> getTemplates() {
         return this.templates;
     }
+
+    public Documentation getDocumentation() {
+        return this.documentation;
+    }
+
+    public void setDocumentation(final String url) { this.documentation.url = url; }
+
+    public class Documentation {
+        private String url;
+    }
 }

src/test/java/sipa/blockprovider/examples/BlockTypeWithEndpointTest.java

@@ -18,6 +18,9 @@ void shouldSerializeOneBlockType() {
                         // the block type
                         .addType("bold").withVersion(1, 0, 0)
 
+                        // set documentation
+                        .withDocumentation("http://ww.google.fr")
+
                         // declare the endpoint url
                         .withEndpoint("https://localhost/block-configurations", "GET", "pure")
 

src/test/java/sipa/blockprovider/examples/BlockTypeWithoutEndpointTest.java

@@ -48,6 +48,9 @@ void shouldSerializeTwoBlockTypes() {
                         // the block type
                         .addType("bold").withVersion(1, 0, 0)
 
+                        // set documentation
+                        .withDocumentation("http://ww.google.fr")
+
                         // the input text
                         .addParameter("text")
                         .configurableAsString(null)