<commit_before>FORMAT: 1A

# Admiral

Admiral is a deployment management system for Fleet and CoreOS. Unlike other deployment systems, Admiral also allows for automatic deployment and scaling of Fleet units.

# Admiral Root [/v1]

This resource simply represents the root of the Admiral API. It provides a basic JSON response as validation that the API server is running.

## Retrieve the API Information [GET]
<commit_msg>Add info about configuration<commit_after>FORMAT: 1A

# Admiral

Admiral is a deployment management system for Fleet and CoreOS. Unlike other deployment systems, Admiral also allows for automatic deployment and scaling of Fleet units.

# Configuration

Configuration for Admiral is stored directly in Etcd under the namespace specified by the command line parameter `--ns` (the default is `/admiral`). If this namespace is changed after the application has been launched for the first time already, then unexpected behavior will occur, as Admiral will likely believe it was just installed fresh and without any configuration set.

All configuration keys listed in this section are children of the root namespace. For example, a configuration item listed as `/config/enabled` will be located at `/admiral/config/enabled` with the default namespace.

## API Configuration

Configuration items for the general API.

### Authentication and Registration

#### `/config/registration/enabled`

A boolean indicating whether registration is enabled or not. If the configuration item does not exist, the server will default to disabling registration (i.e. disable registration).

# Admiral API Root [/v1]

This resource simply represents the root of the Admiral API. It provides a basic JSON response as validation that the API server is running.

## Retrieve the API Information [GET]

{'fraction_non_alphanumeric': 0.04669260700389105, 'fraction_numerical': 0.0022234574763757642, 'mean_word_length': 4.806451612903226, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6662544', 'n_tokens_mistral': 402, 'n_tokens_neox': 394, 'n_words': 251}