Home

cryptic-device

Python MicroService for the community project Cryptic-Device

There are two types of models:

---

Device:

Explanation of data keys:

1. user_uuid is the unique identifier for a user account in the game.
2. device_uuid is the unique identifier for a device.
3. name is the new name for changing a device's name.

There are two types of endpoints:

/public                # The endpoint every user has access to
    /<string:uuid>     # The device's uuid
        /info          # Get information about a device -> device.serialize
        /ping          # Ping a device -> device.powered_on
/private               # The endpoint only the owner has access to
    /<string:uuid>     # The device's uuid
        /info          # Get private information about the device -> device.serialize
        /power         # Turn the device on/off
        /name          # Change the name of the device
        /remove        # Delete a device
    /all               # Get a list of all devices
    /create            # Create a device

---

File:

Explanation of data keys:

1. user_uuid is the unique identifier for a user account in the game.
2. device_uuid is the unique identifier for a device.
3. file_uuid is the unique identifier for a file of a device.
4. filename is for creating and updating a file.
5. content is also for creating and updating a file.

Explanation of endpoints:

/<string:device>        # Endpoint that doesn't require a file uuid
    /<string:uuid>      # Endpoint that requires uuid
        /info           # Get information about a file
        /update         # Update a file
        /remove         # Delete a file
    /all                # Get all files of a device
    /create             # Create a new file

---