Skip to content

Commit 972a1fd

Browse files
committed
chore: fixing javadoc
Signed-off-by: Emmanuel Hugonnet <ehugonne@redhat.com>
1 parent 5e1e8e9 commit 972a1fd

31 files changed

Lines changed: 133 additions & 7 deletions

spec/src/main/java/io/a2a/json/JsonUtil.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,6 @@ private static GsonBuilder createBaseGsonBuilder() {
8787
* <p>
8888
* Used throughout the SDK for consistent JSON serialization and deserialization.
8989
*
90-
* @see GsonFactory#createGson()
9190
*/
9291
public static final Gson OBJECT_MAPPER = createBaseGsonBuilder()
9392
.registerTypeHierarchyAdapter(Part.class, new PartTypeAdapter())

spec/src/main/java/io/a2a/spec/AgentCapabilities.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
/**
66
* Defines optional capabilities supported by an agent.
7+
*
8+
* @param streaming whether the agent supports streaming responses
9+
* @param pushNotifications whether the agent supports push notifications
10+
* @param stateTransitionHistory whether the agent supports state transition history
11+
* @param extensions optional list of protocol extensions supported by the agent
712
*/
813
public record AgentCapabilities(boolean streaming, boolean pushNotifications, boolean stateTransitionHistory,
914
List<AgentExtension> extensions) {

spec/src/main/java/io/a2a/spec/AgentCard.java

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,25 @@
1010
* The AgentCard is a self-describing manifest for an agent. It provides essential
1111
* metadata including the agent's identity, capabilities, skills, supported
1212
* communication methods, and security requirements.
13+
*
14+
* @param name the human-readable name of the agent
15+
* @param description a human-readable description of the agent
16+
* @param url the URL of the agent's primary endpoint
17+
* @param provider the organization or individual providing the agent
18+
* @param version the version of the agent
19+
* @param documentationUrl optional URL to the agent's documentation
20+
* @param capabilities the capabilities supported by the agent
21+
* @param defaultInputModes the default input content modes supported by the agent
22+
* @param defaultOutputModes the default output content modes supported by the agent
23+
* @param skills the list of skills the agent can perform
24+
* @param supportsAuthenticatedExtendedCard whether the agent supports an authenticated extended card
25+
* @param securitySchemes the security scheme definitions available for this agent
26+
* @param security the security requirements for accessing the agent
27+
* @param iconUrl optional URL to the agent's icon
28+
* @param additionalInterfaces additional transport/URL combinations for interacting with the agent
29+
* @param preferredTransport the preferred transport protocol
30+
* @param protocolVersion the A2A protocol version supported by the agent
31+
* @param signatures optional JWS signatures of the agent card
1332
*/
1433
public record AgentCard(String name, String description, String url, AgentProvider provider,
1534
String version, String documentationUrl, AgentCapabilities capabilities,

spec/src/main/java/io/a2a/spec/AgentCardSignature.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88
/**
99
* Represents a JWS signature of an AgentCard.
1010
* This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).
11+
*
12+
* @param header the JWS unprotected header
13+
* @param protectedHeader the JWS protected header (base64url-encoded)
14+
* @param signature the JWS signature value (base64url-encoded)
1115
*/
1216
public record AgentCardSignature(Map<String, Object> header, @SerializedName("protected")String protectedHeader,
1317
String signature) {

spec/src/main/java/io/a2a/spec/AgentExtension.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66

77
/**
88
* A declaration of a protocol extension supported by an Agent.
9+
*
10+
* @param description a human-readable description of the extension
11+
* @param params optional parameters for configuring the extension
12+
* @param required whether the extension is required for the agent to function
13+
* @param uri the URI identifying the extension
914
*/
1015
public record AgentExtension (String description, Map<String, Object> params, boolean required, String uri) {
1116

spec/src/main/java/io/a2a/spec/AgentInterface.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@
55

66
/**
77
* Declares a combination of a target URL and a transport protocol for interacting with the agent.
8+
*
9+
* @param transport the transport protocol identifier (e.g., "jsonrpc", "grpc")
10+
* @param url the endpoint URL for this transport
811
*/
9-
1012
public record AgentInterface(String transport, String url) {
1113
public AgentInterface {
1214
Assert.checkNotNullParam("transport", transport);

spec/src/main/java/io/a2a/spec/AgentProvider.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
/**
66
* Represents the service provider of an agent.
7+
*
8+
* @param organization the name of the organization providing the agent
9+
* @param url the URL of the provider's website or documentation
710
*/
811
public record AgentProvider(String organization, String url) {
912

spec/src/main/java/io/a2a/spec/AgentSkill.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@
77

88
/**
99
* The set of skills, or distinct capabilities, that the agent can perform.
10+
*
11+
* @param id a unique identifier for the skill
12+
* @param name the human-readable name of the skill
13+
* @param description a human-readable description of the skill
14+
* @param tags tags for categorizing or discovering the skill
15+
* @param examples example prompts or use cases for the skill
16+
* @param inputModes the content modes accepted as input by the skill
17+
* @param outputModes the content modes produced as output by the skill
18+
* @param security optional security requirements specific to this skill
1019
*/
1120
public record AgentSkill(String id, String name, String description, List<String> tags,
1221
List<String> examples, List<String> inputModes, List<String> outputModes,

spec/src/main/java/io/a2a/spec/Artifact.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@
77

88
/**
99
* Represents a file, data structure, or other resource generated by an agent during a task.
10+
*
11+
* @param artifactId a unique identifier for the artifact within the task
12+
* @param name optional human-readable name of the artifact
13+
* @param description optional human-readable description of the artifact
14+
* @param parts the content parts that make up the artifact
15+
* @param metadata optional additional metadata associated with the artifact
16+
* @param extensions optional list of protocol extension identifiers
1017
*/
1118
public record Artifact(String artifactId, String name, String description, List<Part<?>> parts, Map<String, Object> metadata,
1219
List<String> extensions) {

spec/src/main/java/io/a2a/spec/AuthenticationInfo.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
/**
88
* The authentication info for an agent.
9+
*
10+
* @param schemes the list of authentication scheme identifiers
11+
* @param credentials optional credentials string for the authentication scheme
912
*/
1013
public record AuthenticationInfo(List<String> schemes, String credentials) {
1114

0 commit comments

Comments
 (0)