[Feat]: Clarify nullability and optionality of the spec API
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Examine the Task and TaskStatus classes in the spec module to understand current nullability patterns. Review the spec API's design principles and consistency rules. Determine which fields should be Optional and which collections should default to empty. Update the classes, ensure backward compatibility, and revise Javadoc accordingly.
Written by the indexing model from the issue text.
Description
Is your feature request related to a problem? Please describe.
The spec API is not consistent with this expectation for the nullability and optionality of objects.
For example, the Task class
will always instantiate its history and artifact with (potentially empty) collections while its metatada can be null.
The API should be consistent unless there is a good reason not to.
In that case, the metadata should also be an empty Map if the parameter is null.
For case where we want to record that a field can have a value or be null, we could also leverage Optional.
For example, in TaskStatus, the message is optional. We could make its type Optional<String> to constrain its contract.
Describe the solution you'd like
Update the spec API to:
- be consistent with the nullabitity of fields (especially collections)
- use the
Optionaltype for optional fields - update the javadoc when there is exception to this general rule
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