That documentation will show up in the Swagger UI at `/docs` in your API, and it will let external developers know how to build the *external API*.

This example doesn't implement the callback itself (that could be just a line of code), only the documentation part.

/// tip

The actual callback is just an HTTP request.

import org.apache.maven.api.annotations.Nullable;
import org.eclipse.aether.transfer.TransferResource;

/**
 * Immutable identifier of a {@link TransferResource}.
 * The {@link TransferResource} is not immutable and does not implement {@code Objects#equals} and {@code Objects#hashCode} methods,
 * making it not very suitable for usage in collections.
 */

 * <p>
 * This interface does not support loading of parent POM(s) from the same backing store, integrators are strongly
 * encouraged to implement {@link ModelSource2} instead of implementing this interface directly.
 *
 * @see ModelSource2
 * @deprecated instead use {@link Source}
 */
@Deprecated

The values returned by [New] and [NewIEEE] now also implement the [encoding.BinaryAppender] interface....

The values returned by [New32], [New32a], [New64], [New64a], [New128] and [New128a] now also implement the [encoding.BinaryAppender] interface....

[Float], [Int] and [Rat] now implement the [encoding.TextAppender] interface....

The values returned by [sha512.New], [sha512.New384], [sha512.New512_224] and [sha512.New512_256] now also implement the [encoding.BinaryAppender] interface....

* Make sure you have well defined Pydantic models for your request bodies and responses.
* Configure any required permissions and roles using dependencies.
* Never store plaintext passwords, only password hashes.
* Implement and use well-known cryptographic tools, like Passlib and JWT tokens, etc.
* Add more granular permission controls with OAuth2 scopes where needed.
* ...etc.

   *
   * <p>Although all tasks are immediately executed in the thread that submitted the task, this
   * {@code ExecutorService} imposes a small locking overhead on each task submission in order to
   * implement shutdown and termination behavior.
   *
   * <p>Because of the nature of single-thread execution, the methods {@code scheduleAtFixedRate}
   * and {@code scheduleWithFixedDelay} are not supported by this class and will throw an

L1:[Level] and [LevelVar] now implement the [encoding.TextAppender] interface.
...