[TechDebt]: Document resource annotation formatting

[jar-b]

Description

All resources and data sources now utilize annotations to facilitate self-registration and configuration of generated code. We should document the expected format for all potential annotations so contributors can better understand the function of annotations and how they should be formatted. This includes the following annotations.

• @SDKResource(...)
• @FrameworkResource(...)
• @SDKDataSource(...)
• @FrameworkDataSource(...)
• @Tags(...)
• @Testing(...)

The first 4 annotations all have the same format, and should just be documented explicitly. The @Tags annotation should document when the identifier key is used versus the plan annotation with no arguments. The @Testing annotation should document all possible arguments and their function (this may already exist in the tags testing docs, but as contributors will likely be reviewing all annotations together it should likely also be documented wherever this final document is published).

Once complete, this document should serve as the guidelines for implementing annotation linters.

References

No response

Would you like to implement a fix?

None

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
• Please see our prioritization guide for information on how we prioritize.
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

Volunteering to Work on This Issue

• If you are interested in working on this issue, please leave a comment.
• If this would be your first contribution, please review the contribution guide.