<commit_before>FORMAT: 1.0

# REST service API for sharing configuration snippets

This is a description of the API provided by the REST service that can be used to share, search and download configuration snippets.


# API Description [/]

## List API methods [GET]

Returns an overview of available API methods with required parameters and a description.

+ Response 200 (text/html; charset=utf-8)



# Authentication endpoint [/auth]<commit_msg>REST service: api-description updated (added resource to query API version)<commit_after>FORMAT: 1.0

# REST service API for sharing configuration snippets

This is a description of the API provided by the REST service that can be used to share, search and download configuration snippets.


# API Description [/]

## List API methods [GET]

Returns an overview of available API methods with required parameters and a description.

+ Response 200 (text/html; charset=utf-8)


## API Version [GET /version]

Returns the currently used version of the API. A version consists of two numbers (format: a.b), where the first number (a) is the major version and the second number (b) the minor version. Minor versions may not contain breaking changes (i.e. backwards-compatibility is ensured), but major versions may. This means that minor versions may only extend the API.

+ Response 200 (application/json)
    + Attributes (object)
        + version (string) - The currently used version in its complete format
        + major (number) - The currently used major version
        + minor (number) - The currently used minor version



# Authentication endpoint [/auth]
{'fraction_non_alphanumeric': 0.06393544382371198, 'fraction_numerical': 0.00931098696461825, 'mean_word_length': 4.10126582278481, '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': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2884043', 'n_tokens_mistral': 417, 'n_tokens_neox': 385, 'n_words': 215}