Skip to content

Add FileAPI endpoints#13

Merged
Foorack merged 16 commits intovrchatapi:masterfrom
Foorack:fileapi
Jul 13, 2021
Merged

Add FileAPI endpoints#13
Foorack merged 16 commits intovrchatapi:masterfrom
Foorack:fileapi

Conversation

@Foorack
Copy link
Copy Markdown
Member

@Foorack Foorack commented Jul 11, 2021

Fixes #6

The comment on the Docsify/Markdown version was right, the FileAPI and especially File upload is indeed wonky. Sometimes requests just times out with no response. As the SDK is the only part uploading files through these endpoints there is also incredibly limited information/documentation on any of these. The Gallery/Icon upload on the website uses completely different endpoints.

This FileAPI documentation ideally needs to be improved even further in future updates. It would be good to add more instructions and an outline of the whole timeline from start to finish with all the required steps to upload a file with delta and signature. More testing is also needed to see if different edge cases are covered (e.g. simple vs multipart upload).

@Foorack Foorack added Type: Enhancement This will **improve** existing or **add** something new Priority: High High priority, this ideally needs to be fixed first labels Jul 11, 2021
@Foorack Foorack added this to the Docsify OpenAPI Parity milestone Jul 11, 2021
@Foorack Foorack self-assigned this Jul 11, 2021
@Foorack Foorack added the Status: In Progress This is being worked on... label Jul 12, 2021
@Foorack Foorack added Status: Completed We did it! Ready to merge! and removed Status: In Progress This is being worked on... labels Jul 13, 2021
@Foorack
Copy link
Copy Markdown
Member Author

Foorack commented Jul 13, 2021

This should cover the base implementation of uploading, managing, and deleting files.

Further documentation, especially in areas to how .signature and deltas are calculated and generated, as well as a complete overview picture of the flow from start to finish is severely needed, but something which should be added in a future commit. The cost of perfection is infinite; this is a starting point, and right now there are more critical areas to cover such as Avatars, Instances and Worlds.

This will be revisited once automatic library generation has been further researched, and the various API calls can be automated. The FileAPI is particularly laborious to test manually.

@Foorack Foorack merged commit 6143925 into vrchatapi:master Jul 13, 2021
@Foorack Foorack deleted the fileapi branch July 13, 2021 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: High High priority, this ideally needs to be fixed first Status: Completed We did it! Ready to merge! Type: Enhancement This will **improve** existing or **add** something new

Development

Successfully merging this pull request may close these issues.

Document File API

1 participant