mirrors/compiler-explorer
1
0
Fork 0
mirror of https://github.com/compiler-explorer/compiler-explorer.git synced 2025-12-27 09:23:52 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs(api): improved clientstate API documentation describing need for unicode conversion (#4114)

Browse Source 
* docs(api): improved clientstate API documentation describing need for unicode conversion

* docs: improve CONTRIBUTORS.md
This commit is contained in:
Jackson Machado
2022-10-10 08:40:06 -03:00
committed by GitHub
parent b25e443bbb
commit 2bc257d89d
2 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/API.md
View File

@@ -306,6 +306,8 @@ This call is to open the website with a given state (without having to store the
Instead of sending the ClientState JSON in the post body, it will have to be encoded with base64 and attached directly
onto the URL.
To avoid problems in reading base64 by the API, some characters must be kept in unicode. Therefore, before calling the API, it is necessary to replace these characters with their respective unicodes. A suggestion is to use the Regex expression `/[\u007F-\uFFFF]/g` that allows mapping these characters.
# Implementations
Here are some examples of projects using the Compiler Explorer API: