/** The key of the message: Realm */
    public static final String LABELS_AUTH_REALM = "{labels.authRealm}";

    /** The key of the message: Status */
    public static final String LABELS_AVAILABLE = "{labels.available}";

    /** The key of the message: Created By */
    public static final String LABELS_CREATED_BY = "{labels.createdBy}";

    /** The key of the message: Created Time */

            "The filename, directory name, or volume label syntax is incorrect.", "The system cannot find the file specified.",
            "Cannot create a file when that file already exists.", "The handle is invalid.", "The specified path is invalid.",
            "The system cannot find the path specified.", "The specified path is invalid.",

     *
     * @param <KEY> the key type of the <code>Map</code>
     * @param <VALUE> the value type of the <code>Map</code>
     * @param key the key to be added to the <code>Map</code>
     * @param value the value to be added to the <code>Map</code>
     * @return a {@literal Maps} for constructing a {@link ConcurrentHashMap} with the specified key and value
     */

     *       class path or on the module path, but only one of those. The choice is up to the plugin,
     *       possibly using heuristic rules (Maven 3 behavior).</li>
     *   <li>If a {@link #patchModule(String)} is also set and the main JAR file is placed on the module path,

/*
 * Copyright 2012-2025 CodeLibs Project and the Others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,

    /**
     * The URL for the HTTP request.
     */
    protected String url;

    /**
     * The proxy to be used for the HTTP request.
     */
    protected Proxy proxy;

    /**
     * The character encoding for the request.
     */
    protected String encoding = "UTF-8";

    /**
     * The threshold size for the request body.
     */

So, what we will do next is add the code to document how that *external API* should look like to receive the callback from *your API*.

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

#### `HeroCreate` - the *data model* to create a hero { #herocreate-the-data-model-to-create-a-hero }

Now we create a `HeroCreate` model, this is the one that will **validate** the data from the clients.

It has the same fields as `HeroBase`, and it also has `secret_name`.

* `title`: the title of your API.
* `oauth2_redirect_url`: you can use `app.swagger_ui_oauth2_redirect_url` here to use the default.
* `swagger_js_url`: the URL where the HTML for your Swagger UI docs can get the **JavaScript** file. This is the custom CDN URL.

That demonstrates how the Proxy (Traefik) uses the path prefix and how the server (Uvicorn) uses the `root_path` from the option `--root-path`.

### Check the docs UI { #check-the-docs-ui }

But here's the fun part. ✨