Skip to content

Commit c8c3d0f

Browse files
committed
Added docs to get param names in deploy-functions and updated version.
1 parent bfd2727 commit c8c3d0f

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Java Client Library (beta)
2-
### v0.4.1
2+
### v0.4.2
33

44
## Introduction
55
Welcome my friends! This is the Poly API Java client GitHub page. If you are here, then it means you're familiar with what we do at Poly. If you aren't, you can always check [here](https://github.com/polyapi/poly-alpha).
@@ -87,7 +87,15 @@ Nice to have some customers looking around here! So, you'll need to run the foll
8787
</execution>
8888
</executions>
8989
</plugin>
90-
<plugin>
90+
<plugin>
91+
<groupId>org.apache.maven.plugins</groupId>
92+
<artifactId>maven-compiler-plugin</artifactId>
93+
<version>3.12.1</version>
94+
<configuration>
95+
<parameters>true</parameters>
96+
</configuration>
97+
</plugin>
98+
<plugin>
9199
<groupId>org.codehaus.mojo</groupId>
92100
<artifactId>build-helper-maven-plugin</artifactId>
93101
<version>3.2.0</version>
@@ -222,6 +230,19 @@ This MOJO requires a project to run and the commons library to be set as a depen
222230
```
223231
It scans the project for classes annotated with `@PolyFunction` and it will upload them. See the documentation of the class for documentation. If the class is also annotated with `@RequiredDependency` it will add the dependencies indicated in the annotation to the server function so they will provide their classes when the function executes.'
224232

233+
This MOJO uses reflection to retrieve the information from the functions to deploy. In order to properly obtain the property names for the arguments, the following plugin needs to be added:
234+
```xml
235+
<plugin>
236+
<groupId>org.apache.maven.plugins</groupId>
237+
<artifactId>maven-compiler-plugin</artifactId>
238+
<version>3.12.1</version>
239+
<configuration>
240+
<parameters>true</parameters>
241+
</configuration>
242+
</plugin>
243+
```
244+
Otherwise argument names will be shown as "arg0", "arg1", etc.
245+
225246
##### Parameters
226247
Here's the list of parameters:
227248
- **host (required):** The host where the Poly API instance is hosted.
@@ -347,6 +368,8 @@ Comparing to its Typescript counterpart, the Java library is still missing the f
347368
These features will be added in the future releases.
348369

349370
## Changelog
371+
### v0.4.2
372+
- TBD
350373
### v0.4.1
351374
- Added Function ID in the javadocs of functions.
352375
### v0.4.0

0 commit comments

Comments
 (0)