Skip to content

Link the API reference at api-docs.transifex.com #132

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SerafeimMarg merged 1 commit into from
Oct 20, 2026
Merged

Link the API reference at api-docs.transifex.com #132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions transifex/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
A python SDK for the [Transifex API (v3)](https://transifex.github.io/openapi/)
A python SDK for the [Transifex API (v3)](https://api-docs.transifex.com/)

## Introduction

Expand Down Expand Up @@ -86,7 +86,7 @@ projects = transifex_api.Project.filter(organization=organization)
```

However, if you look at how a project is represented in the
[API docs](https://transifex.github.io/openapi/#tag/Projects/paths/~1projects~1{project_id}/get),
[API docs](https://api-docs.transifex.com/#tag/Projects/paths/~1projects~1{project_id}/get),
Organization objects have a `projects` relationship with a `related` links, so
you can achieve the same thing with:

Expand All @@ -95,7 +95,7 @@ projects = organization.fetch('projects')
```

If you look into the
[API docs](https://transifex.github.io/openapi/#tag/Projects/paths/~1projects/get),
[API docs](https://api-docs.transifex.com/#tag/Projects/paths/~1projects/get),
you can see that a `slug` filter is also supported, so to find a specific
project, you can do:

Expand Down Expand Up @@ -180,7 +180,7 @@ project.change('team', team_2)
```

This will send a PATCH request to
[`/projects/XXX/relationships/team`](https://transifex.github.io/openapi/#tag/Projects/paths/~1projects~1{project_id}~1relationships~1team/patch)
[`/projects/XXX/relationships/team`](https://api-docs.transifex.com/#tag/Projects/paths/~1projects~1{project_id}~1relationships~1team/patch)
to perform the change. Again, you should consult the API documentation to see
which relationships can be changed and with which methods (in this case -
changing a project's team - both methods are available).
Expand Down Expand Up @@ -1252,7 +1252,7 @@ will retrieve that location and process the response using the appropriate
class.

Given these two mechanisms, here is how you might go about performing a
[source file upload](https://transifex.github.io/openapi/#tag/Resource-Strings/paths/~1resource_strings_async_uploads/post)
[source file upload](https://api-docs.transifex.com/#tag/Resource-Strings/paths/~1resource_strings_async_uploads/post)
in Transifex API:

```python
Expand Down
Loading