You will see the automatic interactive API documentation (provided by <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank">Swagger UI</a>):

 *
 * Features:
 * - Per-account rate limiting
 * - Per-IP rate limiting
 * - Global rate limiting
 * - Exponential backoff for repeated failures
 * - Account lockout after threshold
 * - Automatic cleanup of old entries
 */
public class AuthenticationRateLimiter implements AutoCloseable {

    private static final Logger log = LoggerFactory.getLogger(AuthenticationRateLimiter.class);

    </class>
    <class>
      <name>Activation</name>
      <version>1.0.0</version>
      <description><![CDATA[
        The conditions within the build runtime environment which will trigger
        the automatic inclusion of the parent build profile.
      ]]></description>
      <fields>
        <field>
          <name>activeByDefault</name>
          <version>1.0.0</version>
          <type>boolean</type>

 * retry policies, and contextual information.
 *
 * This exception consolidates the various SMB exception types and provides:
 * - Standardized error codes
 * - Automatic retry policies
 * - Rich contextual information
 * - Error categorization
 * - Performance metrics
 */
public class SmbOperationException extends CIFSException implements Serializable {

/// info

Even after OpenAPI 3.1.0 was released with this new simpler integration with JSON Schema, for a while, Swagger UI, the tool that provides the automatic docs, didn't support OpenAPI 3.1.0 (it does since version 5.0.0 🎉).

Because of that, versions of FastAPI previous to 0.99.0 still used versions of OpenAPI lower than 3.1.0.

///

  @Nullable Strength valueStrength;

  @Nullable Equivalence<Object> keyEquivalence;

  /**
   * Constructs a new {@code MapMaker} instance with default settings, including strong keys, strong
   * values, and no automatic eviction of any kind.
   */
  public MapMaker() {}

  /**
   * Sets a custom {@code Equivalence} strategy for comparing keys.
   *

This code won't be executed in your app, we only need it to *document* how that *external API* should look like.

But, you already know how to easily create automatic documentation for an API with **FastAPI**.

  @get:JvmName("cacheResponse") val cacheResponse: Response?,
  /**
   * Returns the response for the HTTP redirect or authorization challenge that triggered this
   * response, or null if this response wasn't triggered by an automatic retry. The body of the
   * returned response should not be read because it has already been consumed by the redirecting
   * client.
   */
  @get:JvmName("priorResponse") val priorResponse: Response?,
  /**

/// warning

A `Response` returned directly by your *path operation function* won't be documented in OpenAPI (for example, the `Content-Type` won't be documented) and won't be visible in the automatic interactive docs.

///

/// info

Of course, the actual `Content-Type` header, status code, etc, will come from the `Response` object you returned.

///

        byte[] newKey = new byte[16];
        assertThrows(IllegalStateException.class, () -> {
            context.rotateKeys(newKey, newKey);
        });
    }

    @Test
    @DisplayName("Should perform automatic key rotation when session key is provided")
    void testAutomaticKeyRotation() throws Exception {
        // Given - Create context with session key for rotation support
        byte[] sessionKey = new byte[16];