Can we use Atlassian's @PublicApi and @PublicSpi annotations in our own plugin's API?

[Igor Sereda [ALM Works]]

Technically, we can, of course.

The question is:

• would it have unambiguous meaning (no confusion) to the developer who's working with our API,
• would it be beneficial for the developer (we have both API and SPI, and the same versioning/compatibility contract)
• would any of the Atlassian tools like checkup go crazy because of that.

Thanks!

[mlassau_atlassian]

If you are producing a plugin that exposes API / SPI of its own, then I think using those annotations would be a useful way to codify the compatibility contract.

would any of the Atlassian tools like checkup go crazy because of that.

We do have an "API compatibilty check" Bamboo build in JIRA that checks that we haven't broken anything in jira-api.jar

... but I don't see how any Atlassian tool would be looking at jars from ecosystem developers, so its hard to imagine it doing any harm.

[&(*&)#)_*#@@(*)(@*)(*@]

hi,

i see no benefice... unambiguous meaning is done with proper namming and classe modifier, if you realy want that mark you method , juste create your own annotation :)

best regards,