Kraken Resources

Resource	Endpoint	Description
User	Get Users	Get list of Users @index
User	Get Users	Get list of Users @index2
User	Get Users	Get list of Users
My Test	Get Test	Hihi not a user resource in my user controller
User	Patch user	Update an user object.

User

Get Users

GEThttps://api.example.org/kraken/users

Get list of Users @index

Request Query Parameters

Field	Type	Required	Description
my_query_parameter	Date	No	Example Description

Response Body

Field	Type	Description
id	Integer	No description
username	String	No description
email	String	No description
overlay_token	String	No description
created_at	Datetime	No description

Example response

{
    "id": 42,
    "username": "derpierre65",
    "email": "hello@derpierre65.dev",
    "overlay_token": "pu72I3Vkz7iAJegTpzp28ctTWsm",
    "created_at": "2022-01-01T00:00:00Z"
}

Get Users

GEThttps://api.example.org/kraken/users

Get list of Users @index2

Response Body

Field	Type	Description
data	Array[]	No description
id	Integer	No description
username	String	No description
email	String	No description
overlay_token	String	No description
created_at	Datetime	No description

Example response

{
    "data": [
        {
            "id": 42,
            "username": "derpierre65",
            "email": "hello@derpierre65.dev",
            "overlay_token": "pu72I3Vkz7iAJegTpzp28ctTWsm",
            "created_at": "2022-01-01T00:00:00Z"
        }
    ]
}

Get Users

GEThttps://api.example.org/kraken/users

Get list of Users

Response Body

Field	Type	Description
a	Object	No description
b	Object	No description
c	Object	No description
d	Object	No description
enabled	Boolean	No description

Example response

{
    "a": {
        "b": {
            "c": {
                "d": {
                    "enabled": true
                }
            }
        }
    }
}

Patch user

PATCHhttps://api.example.org/kraken/users

Update an user object.

Request Body Parameters

Field	Type	Required	Description
email	String	Yes	Example Description
username	String	No	No description

Example response

[]

My Test

Get Test

GEThttps://api.example.org/kraken/not-an-user

Hihi not a user resource in my user controller

Response Body

Field	Type	Description
id	Integer	No description
username	String	No description
email	String	No description
overlay_token	String	No description
created_at	Datetime	No description
just_an_object	Object	No description
datetime	Datetime	No description
my_string	String	No description
nested_object_array	Object[]	No description
datetime	Datetime	No description
my_string	String	No description
test	Object	No description
id	Integer	No description
username	String	No description
email	String	No description
overlay_token	String	No description
created_at	Datetime	No description

Example response

{
    "id": 42,
    "username": "derpierre65",
    "email": "hello@derpierre65.dev",
    "overlay_token": "pu72I3Vkz7iAJegTpzp28ctTWsm",
    "created_at": "2022-01-01T00:00:00Z",
    "just_an_object": {
        "datetime": "2022-01-01T00:00:00Z",
        "my_string": "hello world"
    },
    "nested_object_array": [
        {
            "datetime": "2022-01-01T00:00:00Z",
            "my_string": "hello world"
        }
    ],
    "test": {
        "id": 42,
        "username": "derpierre65",
        "email": "hello@derpierre65.dev",
        "overlay_token": "pu72I3Vkz7iAJegTpzp28ctTWsm",
        "created_at": "2022-01-01T00:00:00Z"
    }
}