Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Transfer Images via Backend Instead of RPCs #756

Open
tinxx opened this issue Aug 7, 2024 · 0 comments
Open

Transfer Images via Backend Instead of RPCs #756

tinxx opened this issue Aug 7, 2024 · 0 comments
Labels
Improvement Improvement of existing features

Comments

@tinxx
Copy link
Collaborator

tinxx commented Aug 7, 2024

The Backend provides an API for sharing Code City projects with its clients. The Code Cities are static data that cannot be modified by SEE clients.

Similarly, API endpoints should be implemented to allow uploading dynamic data by SEE clients.

  • Endpoint to upload files for a server by SEE clients, authorized by the server password
  • Endpoint to retrieve these files via their id, authorized by the server password

The first use case that should be implemented along with the API is as follows:

  • Replace the transfer of images used in drawables (whiteboad) to use the back-end API instead of the standard RPC method.
    • The SEE client uploads the image to the Backend via the new API endpoint.
    • The SEE client receives the FileData metadata object as a response from the Backend.
    • The SEE client constructs the URL with the file id to retrieve it via the second endpoint
    • The URL is stored in a DataPath and transferred via the RPC mechanism to the other clients.
    • Optionally, the old method of transferring images via RPCs can be kept as a fallback for cases when no backend server is configured (e.g, in the Unit editor).
@tinxx tinxx added the Improvement Improvement of existing features label Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Improvement of existing features
Projects
None yet
Development

No branches or pull requests

1 participant