<commit_before># Pathwar API
Official Pathwar REST Api


## Authentication
To be defined


## Media Types
This API uses the json media-type to represent resources states and affordances.

Requests with a message-body are using plain JSON to set or update resource states.


## Error States
The common [HTTP Response Status Codes](https://github.com/for-GET/know-your-http-well/blob/master/status-codes.md) are used.


# Group People
This section describes about the People


## User [/user/{id}]
This resource represents one particular user identified by its *id*.

+ Parameters
    + id (string, `1`) ... The id of the User.

+ Model (application/json)
    JSON representation of User resource.
    + Body

        ```js
        {
          "name": "m1ch3l",
          "birthdate": "04-02-1942",
          "organization_id": "xxxx-xxxxxx-xxxxxx-xxxx"
        }
        ```


### Retrieve User [GET]
Return the information for the User

+ Request (application/json)

+ Response 200 (application/json)

    [User][]


## Organization [/organization/{id}]
This resource represents one particular organization identified by its *id*.

+ Model (application/json)
    JSON representation of Organization resource.
    + Body

        ```js
        {
          "name": "ulteam",
          "members": [
            "xxxx-xxxxxx-xxxxxx-xxxx",
            "xxxx-xxxxxx-xxxxxx-xxxx",
          ]
        }
        ```


### Retrieve Organization [GET]
Return the information for the Organization

+ Request (application/json)

+ Response 200 (application/json)

    [Organization][]


# Group Level
This section describes about the Level


## Level [/level/{id}]
This resource represents one particular level identified by its *id*.

+ Model (application/json)
    JSON representation of a Level resource.
    + Body

        ```js
        {
          "name": "pwnland",
          "description": "pwnland is cool",
          "author": "<NAME> (@pathwar_net)"
        }
        ```


### Retrieve Level [GET]
Return the information for the Level

+ Request (application/json)

+ Response 200 (application/json)

    [Level][]


## Level Collection [/level]
Collection of levels.

+ Model (application/json)
    JSON representation of a Level resource.
    + Body

        ```js
        {
          "count": 2,
          "_embedded": [
            {
              "name": "pwnland",
              "description": "pwnland is cool",
              "author": "Pathwar Team (@pathwar_net)"
            },
            {
              "name": "megapwnland",
              "description": "megapwnland is megacool",
              "author": "Pathwar Team (@pathwar_net)"
            }
          ]
        }
        ```


### List all levels [GET]

+ Response 200 (application/json)

    [Level Collection][]


# Group Coupon
This section describes about the Coupon


## Coupon [/coupon/{id}]
This resource represents one particular coupon identified by its *id*.

+ Model (application/json)
    JSON representation of a Coupon resource.
    + Body

        ```js
        {
          "name": "magic coupon"
        }
        ```


### Retrieve Achievement [GET]
Return the information for the Achievement

+ Request (application/json)

+ Response 200 (application/json)

    [Achievement][]

# Group Achievement
This section describes about the Achievement


## Achievement [/achievement/{id}]
This resource represents one particular achievement identified by its *id*.

+ Model (application/json)
    JSON representation of a Achievement resource.
    + Body

        ```js
        {
          "name": "hack the planet",
          "description": "Finish all the levels"
        }
        ```


### Retrieve Achievement [GET]
Return the information for the Achievement

+ Request (application/json)

+ Response 200 (application/json)

    [Achievement][]
<commit_msg>Removed useless data<commit_after># Pathwar API
Official Pathwar REST Api


## Authentication
To be defined


## Media Types
This API uses the json media-type to represent resources states and affordances.

Requests with a message-body are using plain JSON to set or update resource states.


## Error States
The common [HTTP Response Status Codes](https://github.com/for-GET/know-your-http-well/blob/master/status-codes.md) are used.


# Group People
This section describes about the People


## User [/user/{id}]
This resource represents one particular user identified by its *id*.

+ Parameters
    + id (string, `1`) ... The id of the User.

+ Model (application/json)
    JSON representation of User resource.
    + Body

        ```js
        {
          "name": "m1ch3l",
          "birthdate": "04-02-1942",
          "organization_id": "xxxx-xxxxxx-xxxxxx-xxxx"
        }
        ```


### Retrieve User [GET]
Return the information for the User

+ Response 200 (application/json)

    [User][]


## Organization [/organization/{id}]
This resource represents one particular organization identified by its *id*.

+ Model (application/json)
    JSON representation of Organization resource.
    + Body

        ```js
        {
          "name": "ulteam",
          "members": [
            "xxxx-xxxxxx-xxxxxx-xxxx",
            "xxxx-xxxxxx-xxxxxx-xxxx",
          ]
        }
        ```


### Retrieve Organization [GET]
Return the information for the Organization

+ Response 200 (application/json)

    [Organization][]


# Group Level
This section describes about the Level


## Level [/level/{id}]
This resource represents one particular level identified by its *id*.

+ Model (application/json)
    JSON representation of a Level resource.
    + Body

        ```js
        {
          "name": "pwnland",
          "description": "pwnland is cool",
          "author": "<NAME> (@pathwar_net)"
        }
        ```


### Retrieve Level [GET]
Return the information for the Level

+ Response 200 (application/json)

    [Level][]


## Level Collection [/level]
Collection of levels.

+ Model (application/json)
    JSON representation of a Level resource.
    + Body

        ```js
        {
          "count": 2,
          "_embedded": [
            {
              "name": "pwnland",
              "description": "pwnland is cool",
              "author": "Path<NAME> (@pathwar_net)"
            },
            {
              "name": "megapwnland",
              "description": "megapwnland is megacool",
              "author": "<NAME> (@pathwar_net)"
            }
          ]
        }
        ```


### List all levels [GET]

+ Response 200 (application/json)

    [Level Collection][]


# Group Coupon
This section describes about the Coupon


## Coupon [/coupon/{id}]
This resource represents one particular coupon identified by its *id*.

+ Model (application/json)
    JSON representation of a Coupon resource.
    + Body

        ```js
        {
          "name": "magic coupon"
        }
        ```


### Retrieve Achievement [GET]
Return the information for the Achievement

+ Response 200 (application/json)

    [Achievement][]

# Group Achievement
This section describes about the Achievement


## Achievement [/achievement/{id}]
This resource represents one particular achievement identified by its *id*.

+ Model (application/json)
    JSON representation of a Achievement resource.
    + Body

        ```js
        {
          "name": "hack the planet",
          "description": "Finish all the levels"
        }
        ```


### Retrieve Achievement [GET]
Return the information for the Achievement

+ Response 200 (application/json)

    [Achievement][]

{'fraction_non_alphanumeric': 0.11171553668568396, 'fraction_numerical': 0.00796072707973995, 'mean_word_length': 2.3413120567375887, 'pattern_counts': {'":': 38, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 2, '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': '449223', 'n_tokens_mistral': 2195, 'n_tokens_neox': 2036, 'n_words': 696}