crowdin / crowdin/crowdin-api-client-ruby

Document API resources methods

Open
#34 0 comments 0 reactions 0 assignees View on GitHub
enhancement good first issue hacktoberfest
Dominant language
Ruby
Stars
59
Forks
22
Avg merge
1h 11m
Merged PRs (30d)
1

Description

The Autogenerated online documentation was added in #32. In this PR only the Bundles, Projects, Storage, and Source Files resources were documented.

**Example of the method annotation**:

https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/bundles.rb#L6-L8

---

We need to add annotations for the rest API resources:

- [ ] [dictionaries.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/dictionaries.rb)
- [ ] [distributions.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/distributions.rb)
- [ ] [glossaries.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/glossaries.rb)
- [ ] [labels.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/labels.rb)
- [ ] [languages.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/languages.rb)
- [ ] [machine_translation_engines.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/machine_translation_engines.rb)
- [ ] [reports.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/reports.rb)
- [ ] [screenshots.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/screenshots.rb)
- [ ] [source_strings.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/source_strings.rb)
- [ ] [string_comments.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/string_comments.rb)
- [ ] [string_translations.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/string_translations.rb)
- [ ] [tasks.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/tasks.rb)
- [ ] [teams.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/teams.rb)
- [ ] [translation_memory.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/translation_memory.rb)
- [ ] [translation_status.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/translation_status.rb)
- [ ] [translations.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/translations.rb)
- [ ] [users.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/users.rb)
- [ ] [vendors.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/vendors.rb)
- [ ] [webhooks.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/webhooks.rb)
- [ ] [workflows.rb](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/lib/crowdin-api/api_resources/workflows.rb)

---

API reference:
- [Crowdin API reference](https://developer.crowdin.com/api/v2/)
- [Crowdin Enterprise API reference](https://developer.crowdin.com/enterprise/api/v2/)

Each API resource documentation can be delivered in a separate PR. Also, it's a good idea to join some resources into one PR.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.