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

Now, if you check the docs, they will show all the additional metadata:

<img src="/img/tutorial/metadata/image02.png">

### Order of tags { #order-of-tags }

The order of each tag metadata dictionary also defines the order shown in the docs UI.

For example, even though `users` would go after `items` in alphabetical order, it is shown before them, because we added their metadata as the first dictionary in the list.

* `title`: The OpenAPI title, shown in the docs.
* `version`: The version of your API, e.g. `2.5.0`.
* `openapi_version`: The version of the OpenAPI specification used. By default, the latest: `3.1.0`.
* `summary`: A short summary of the API.
* `description`: The description of your API, this can include markdown and will be shown in the docs.

    /**
     * Notification message displayed on the login page.
     * This message is shown to users on the authentication page.
     */
    @Size(max = 3000)
    public String notificationLogin;

    /**
     * Notification message displayed on the search top page.
     * This message is shown to users on the main search page.
     */
    @Size(max = 3000)
    public String notificationSearchTop;

    }

    /**
     * The CRUD operation mode (create, update, etc.).
     */
    @ValidateTypeFailure
    public Integer crudMode;

    /**
     * The search term for which related queries are shown.
     */
    @Required
    @Size(max = 10000)
    public String term;

    /**
     * The related queries to be suggested (one per line).
     */
    @Required
    @Size(max = 10000)

To add a summary and description to your *path operations*, and show them in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Summary and Description](../tutorial/path-operation-configuration.md#summary-and-description){.internal-link target=_blank}.

## Documentation Response description - OpenAPI { #documentation-response-description-openapi }

    }

    /**
     * The CRUD operation mode (create, update, etc.).
     */
    @ValidateTypeFailure
    public Integer crudMode;

    /**
     * The search term for which related content is shown.
     */
    @Required
    @Size(max = 10000)
    public String term;

    /**
     * The related content to be displayed.
     */
    @Required
    @Size(max = 10000)
    public String content;

 *       }
 *     };
 * iteratorTester.test();
 * iteratorTester.testForEachRemaining();
 * }
 *
 * <p><b>Note</b>: It is necessary to use {@code IteratorTester.KnownOrder} as shown above, rather
 * than {@code KnownOrder} directly, because otherwise the code cannot be compiled.
 *
 * @author Kevin Bourrillion
 * @author Chris Povirk
 */
@GwtCompatible
@NullMarked

 *       }
 *     };
 * iteratorTester.test();
 * iteratorTester.testForEachRemaining();
 * }
 *
 * <p><b>Note</b>: It is necessary to use {@code IteratorTester.KnownOrder} as shown above, rather
 * than {@code KnownOrder} directly, because otherwise the code cannot be compiled.
 *
 * @author Kevin Bourrillion
 * @author Chris Povirk
 */
@GwtCompatible
@NullMarked

        // Note: completionFilter is displayed with 4 hex chars, not 8
        assertTrue(result.contains("fid=0xFFFF"));
        assertTrue(result.contains("filter=0xFFFF")); // Only 4 hex chars are shown
        assertTrue(result.contains("watchTree=true"));
    }

    @Test
    @DisplayName("Test toString method with zero values")
    void testToStringZeroValues() {
        int fid = 0x0000;

}

type wrapperConnPool struct {
	db     *sql.DB
	got    []string
	expect []string
}

func (c *wrapperConnPool) Ping() error {
	return c.db.Ping()
}

// If you use BeginTx returned *sql.Tx as shown below then you can't record queries in a transaction.
//
//	func (c *wrapperConnPool) BeginTx(ctx context.Context, opts *sql.TxOptions) (*sql.Tx, error) {
//		 return c.db.BeginTx(ctx, opts)
//	}
//