[Feat]: Simplification of the client API?
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 65/100
Research direction
Look at the client API in the spec module, focusing on methods that use XXXParams objects like TaskIdParams. Examine the existing sendMessage method as a reference for the pattern. Identify all methods that could be simplified, then create overloaded versions that accept primitive parameters and delegate to the existing implementations. Ensure backward compatibility and test changes.
Written by the indexing model from the issue text.
Description
Is your feature request related to a problem? Please describe.
The client API is a thin wrapper around the domain objects in the spec module.
I wonder if we could not make the API a bit simpler while retaining all the capabilities it exposes.
Describe the solution you'd like
For example, a lot of calls wrap their parameters in XXXParams object:
public Task cancelTask(TaskIdParams request)
but TaskIdParams is composed of a taskId and a metadata map.
Could the call simply be:
public Task cancelTask(String taskId, Map<String, Object> metadata) {
return clientTransport.cancelTask(new TaskIdParams(taskId, metadata), request, context);
}
and a default method:
public default Task cancelTask(String taskId) {
return cancelTask(taskId, emptyMap();
}
This way, the TaskIdParams does not leak to the Client API (making it bigger than it needs to be.
The API is already to that for its sendMessage methods that hides the internal MessageSendParams.
This is a pattern that should be applied to other methods as well
Describe alternatives you've considered
No response
Additional context
No response
Code of Conduct
- I agree to follow this project's Code of Conduct
- Dominant language
- Java
- Stars
- 514
- Forks
- 200
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 53
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from a2aproject/a2a-java
-
Document 1.x is the actively supported stream, and not 0.3.xPossibly taken @Linux2010 claimed this 2 days ago. Open
Difficulty 1/5 1-3 hours Newbie friendliness 62/100
a2aproject/a2a-java#1321 ·
Maintainers usually reply within 1 day
-
HTTP+JSON CancelTask returns 409 Conflict instead of 400 Bad Request for TaskNotCancelableErrorMay be free again @ravismash claimed this 9 days ago, and no pull request is open. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
a2aproject/a2a-java#1298 · 5 comments ·
Maintainers usually reply within 1 day
-
fix: handle blank push notification config id consistently across transportsPossibly taken @prachisinghal-1 claimed this 23 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
a2aproject/a2a-java#1012 · 2 comments · 1 assignee ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
a2aproject/a2a-java#464 · 1 comment ·
Maintainers usually reply within 1 day
-
Create a sample that demonstrates how to use a shared contextId across multiple tasksMay be free again @tanish111 claimed this 390 days ago, and no pull request is open. Opensample
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
a2aproject/a2a-java#375 · 5 comments · 1 assignee ·
Maintainers usually reply within 1 day
All issues in a2aproject/a2a-java
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/skywalking#14239 ·
Maintainers usually reply within 1 day
-
Re-executed query with IN condition on an index column returns deleted rows (stale IndexCursor)Possibly taken @dbusche claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
h2database/h2database#4580 ·
Maintainers usually reply within 1 day
-
vips-drift
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Stirling-Tools/JPDFium#300 ·
Maintainers usually reply within 1 day
-
hermes-queue
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
chrisalunlloyd2-sudo/mindpalace#403 ·
Maintainers usually reply within 1 day
-
Guidelines: document how to build a use case against a local, unpublished Flow/browserless-test changePossibly taken @totally-not-ai claimed this today. Open
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
vaadin/use-cases#452 · 1 comment ·
Maintainers usually reply within 1 day