Skip to content

Commit 21c4541

Browse files
committed
Added Function ID in the javadocs of functions.
1 parent 894a4bf commit 21c4541

9 files changed

+23
-12
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,8 @@ Comparing to its Typescript counterpart, the Java library is still missing the f
347347
These features will be added in the future releases.
348348

349349
## Changelog
350+
### v0.4.1
351+
- Added Function ID in the javadocs of functions.
350352
### v0.4.0
351353
- Added single function filter to deploy-functions MOJO.
352354
- Fixed Poly functions invocation in webhooks.

polyapi-maven-plugin/src/main/resources/templates/ResolvedApiFunctionSpecification.hbs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ import io.polyapi.client.api.model.PolyMetadata;
77
import {{this}};
88
{{~/each}}
99

10+
/**
11+
* Poly API function with ID {{id}}.
12+
*/
1013
@PolyEntity("{{id}}")
1114
@PolyMetadata(paramNames = { {{{paramNames}}} },
1215
paramTypes = { {{{paramTypes}}} })

polyapi-maven-plugin/src/main/resources/templates/ResolvedAudienceAuthFunctionSpecification.hbs

Lines changed: 0 additions & 11 deletions
This file was deleted.

polyapi-maven-plugin/src/main/resources/templates/ResolvedCustomFunctionSpecification.hbs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ import io.polyapi.client.api.model.PolyMetadata;
77
import {{this}};
88
{{~/each}}
99

10+
/**
11+
* Poly custom function with ID {{id}}.
12+
*/
1013
@PolyEntity("{{id}}")
1114
@PolyMetadata(delegate = "{{{delegate}}}",
1215
paramNames = { {{{paramNames}}} },

polyapi-maven-plugin/src/main/resources/templates/ResolvedServerFunctionSpecification.hbs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ import io.polyapi.client.api.model.PolyMetadata;
77
import {{this}};
88
{{~/each}}
99

10+
/**
11+
* Poly server function with ID {{id}}.
12+
*/
1013
@PolyEntity("{{id}}")
1114
@PolyMetadata(paramNames = { {{{paramNames}}} },
1215
paramTypes = { {{{paramTypes}}} })

polyapi-maven-plugin/src/main/resources/templates/ResolvedServerVariableSpecification.hbs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ import io.polyapi.client.api.model.variable.{{~#if secret}}ServerVariable{{~else
77
import {{this}};
88
{{~/each}}
99

10-
10+
/**
11+
* Poly server variable with ID {{id}}.
12+
*/
1113
@PolyEntity("{{id}}")
1214
@PolyMetadata(paramTypes = "{{{valueType}}}")
1315
public interface {{className}} extends{{~#if secret}} ServerVariable{{~else}} RetrievableServerVariable{{/if}}Handler<{{valueType}}> {

polyapi-maven-plugin/src/main/resources/templates/ResolvedStandardAuthFunctionSpecification.hbs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ import io.polyapi.client.api.model.PolyEntity;
44
import io.polyapi.client.api.model.PolyMetadata;
55
import io.polyapi.client.api.model.function.{{#if this.audienceRequired}}Audience{{/if}}TokenAuthFunction;
66

7+
/**
8+
* Poly auth function with ID {{id}}.
9+
*/
710
@PolyEntity("{{id}}")
811
@PolyMetadata(paramNames = { {{{paramNames}}} },
912
paramTypes = { {{{paramTypes}}} })

polyapi-maven-plugin/src/main/resources/templates/ResolvedSubresourceAuthFunctionSpecification.hbs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ import io.polyapi.client.api.model.PolyMetadata;
55
import io.polyapi.client.api.model.function.SubresourceAuthFunction;
66
import io.polyapi.client.api.model.function.PolyAuthSubresource;
77

8+
/**
9+
* Poly auth function with ID {{id}}.
10+
*/
811
@PolyEntity("{{id}}")
912
@PolyMetadata(paramNames = { {{{paramNames}}} },
1013
paramTypes = { {{{paramTypes}}} })

polyapi-maven-plugin/src/main/resources/templates/ResolvedWebhookHandleSpecification.hbs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ import io.polyapi.client.api.model.websocket.PolyTrigger;
66
import io.polyapi.commons.api.websocket.Handle;
77
import java.util.function.Consumer;
88

9+
/**
10+
* Poly webhook handler with ID {{id}}.
11+
*/
912
@PolyEntity("{{id}}")
1013
@PolyMetadata(paramTypes="{{{eventType}}}")
1114
public interface {{className}} extends PolyTrigger {

0 commit comments

Comments
 (0)