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

String-based API support #214

Closed
14 tasks done
andrii-bodnar opened this issue Dec 28, 2023 · 6 comments · Fixed by #235
Closed
14 tasks done

String-based API support #214

andrii-bodnar opened this issue Dec 28, 2023 · 6 comments · Fixed by #235
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@andrii-bodnar
Copy link
Member

andrii-bodnar commented Dec 28, 2023

Crowdin has recently released a new type of projects - String-based.

In string-based projects, the focus is on managing translatable content as individual strings rather than source files. In this project type, after uploading source files, Crowdin parses them into source strings. Unlike file-based projects, source files aren’t stored, and the emphasis is on managing the content at the string level. This approach is beneficial when dealing with projects that involve continuous content updates, dynamic content, or where a string-oriented structure is preferred.

As a result, the API differs a bit from the file-based projects. Most of the endpoints are the same, but some endpoints have different parameters or return different responses, some endpoints are not available at all, and some new endpoints are available only for string-based projects.

We should update the API clients to support string-based projects as well.

Progress:

String-based support for (#224):

  • Clients API
  • Bundles
  • Distributions
  • Labels
  • Machine Translations

Remaining String-based support for:

  • Projects api
  • Branches api
  • Reports api
  • String translations api
  • Tasks api
  • Translation status api
  • Translations api
  • Webhooks api
  • Strings api

References:

It has been implemented for the following clients:

@andrii-bodnar andrii-bodnar added enhancement New feature or request help wanted Extra attention is needed labels Dec 28, 2023
@innomaxx innomaxx self-assigned this Jan 2, 2024
@Zahid92
Copy link
Contributor

Zahid92 commented Jan 17, 2024

Hi @andrii-bodnar, I would like to try implementing this as well.

@andrii-bodnar
Copy link
Member Author

Hi @Zahid92, awesome, thank you!

Assigning it to you. Feel free to contact me here if you have any questions.

@andrii-bodnar
Copy link
Member Author

Hi @Zahid92 do you have any updates on this?

@Zahid92
Copy link
Contributor

Zahid92 commented Feb 1, 2024

Sorry, I got busy with some personal stuff.
I have gone through with the mentioned PR's and will make the changes accordingly.

@Zahid92
Copy link
Contributor

Zahid92 commented Feb 28, 2024

Hi @andrii-bodnar in ListLabels isSystem is an enum for {0, 1}.
Should it be a bool instead of enum??

@andrii-bodnar
Copy link
Member Author

Hi @Zahid92, well, nice question :)

For some unknown reason it was implemented this way, but it's actually better to have the boolean type here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants