Upgrade Crowdin API's
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.3k
- Forks
- 641
- Avg merge
- 12h 4m
- Merged PRs (30d)
- 57
Description
Message from Crowdin -
Hello,
You've received this email because you're currently using Crowdin API v1 or services built upon it (e.g., CLI, SDK, etc.).
In our continuous effort to provide you with the best experience and improved functionality, we will be removing API v1 from our platform. Effective from November 30, 2023, API v1 will no longer be supported.
This change means that any integrations, tools like CLI, SDK, or other services relying on API v1 will cease to function. To ensure uninterrupted service, we recommend migrating to API v2, which offers enhanced features and compatibility.
Learn more:
From Joey - The docs upload path in the CI builds still is using v1 api, I had given it a quick shot and backed off upgrading it back when I changed how the backend read out the translations from the server making requests to our backup repo- it was very early in their v2 api and it was missing lots of functionality that appear to have been added since then (also, that upload path in our cli is a little clunky at the best of times, e.g. the way it handles making sure folders exist is to just send a "make folder" request for each subfolder and checking the error code to see if the folder already existed). While we're making changes we should give it another look to see how we can trim it down to only upload changed files, as it's taking a big chunk of our build time currently.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the docs upload path in the CI builds and the CLI code that talks to Crowdin. Compare its current API v1 requests with the Crowdin API v2 documentation, then determine how changed-file uploads and folder handling should work; done means the CI upload path uses the supported API and avoids unnecessary uploads.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- ci-cd, localization
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100