lokalise / go-lokalise-api Goto Github PK

Documentation: https://lokalise.co/api2docs/go/#resource-keys

Endpoints

• List all keys (paginated)
• Create keys
• Retrieve a key
• Update a key
• Bulk update
• Delete a key

Documentation: https://lokalise.co/api2docs/curl/#resource-files

Endpoints

• List all files (paginated)
• Upload a file
• Download files

Describe the bug
When retrieving translations instead of the string literal & I am getting the unicode \u0026 back.
This is only for the & character:

To Reproduce
Have a translation with the character &. Retrieve translations with github.com/lokalise/go-lokalise-api/v3. The expected & character is replaced with \u0026.

Expected behavior
The & character is returned, not the unicode.

Your environment:
go 1.17

Additional context
This works with our existing node script written in javascript as expected. I can retrieve the & just fine. We are working to update for the upcoming pageLimit of 500 and converting to use Go and this was discovered.

Documentation: https://lokalise.co/api2docs/go/#resource-team-users

Endpoints

• List all team users (paginated)
• Retrieve a team user
• Update a team user
• Delete a team user

Documentation: https://lokalise.co/api2docs/go/#resource-screenshots

Endpoints

• List all screenshots (paginated)
• Create screenshots
• Retrieve a screenshot
• Update a screenshot
• Delete a screenshot

Get a basis request mapping in place used for all endpoints. A light wrapping of the resty library should make this straight forward.

It should be able to handle authentication and pagination by default. A custom wrapping of errors might be useful as well.

• Client
  A Client should be exposed with configuration of timeouts, authentication tokens and base URL.
  We can expose top-level functions that use a default client to allow simple use cases where default values are ok. (Like encoding/json exposing function json.Marshal() and json.NewEncoder())

• Authentication (https://lokalise.co/api2docs/go/#resource-authentication)
  Set header X-Api-Token with the API token.

• Pagination (https://lokalise.co/api2docs/go/#resource-pagination)
  Expose limit and page options for list requests and expose X-Pagination-Total-Count and X-Pagination-Page-Count values in result sets.

• Errors (https://lokalise.co/api2docs/go/#resource-errors)
  The error object holds the HTTP status code and a human readable message.

{
  "code": 400,
  "message": "This key name is already taken"
}

• Logging
  It should be possible to register an io.Writer for custom logging implementations. By default we can write to os.Stderr.
  Maybe also an option to log all requests for debugging purposes. Like a request and response logger.

• Retry mechanism
  All requests should be tried maximum 3 times by default (configurable with a client option). Retries should only happen on timeouts (not context cancelation), network errors and 5xx responses.

Context cancelation
All endpoints should take a context.Context as first argument to facilitate request cancelation by default. This lets clients opt out by using context.Background() but forces them to think about it.

Documentation: https://lokalise.co/api2docs/go/#resource-snapshots

Endpoints

• List all snapshots (paginated)
• Create a snapshot
• Restore a snapshot
• Delete a snapshot

Describe the bug
As the major version tag is bumped to v4, module path in go.mod should be updated to v4.

When trying to upgrade with go get:

$ go get github.com/lokalise/[email protected]
go: github.com/lokalise/[email protected]: invalid version: go.mod has post-v4 module path "github.com/lokalise/go-lokalise-api/v3" at revision v4.0.0

When manually set require as github.com/lokalise/go-lokalise-api/v3 v4.0.0 in my(importing) go.mod:

$ go get
go: errors parsing go.mod:
/.../my-project/go.mod:14:2: require github.com/lokalise/go-lokalise-api/v3: version "v4.0.0" invalid: should be v3, not v4

When set github.com/lokalise/go-lokalise-api/v4 v4.0.0:

$ go get              
go: github.com/lokalise/go-lokalise-api/[email protected]: go.mod has non-.../v4 module path "github.com/lokalise/go-lokalise-api/v3" (and .../v4/go.mod does not exist) at revision v4.0.0

Setting up from new, empty project:

$ go get github.com/lokalise/go-lokalise-api
go: github.com/lokalise/go-lokalise-api: no matching versions for query "upgrade"

To Reproduce
Try upgrading to v4 in existing project, or install newly:

mkdir temp && cd temp
go mod init temp
go get github.com/lokalise/go-lokalise-api

Expected behavior
It should upgrade to v4 well.

Your environment:
darwin/arm64 go1.19.5 and go1.21.3

Additional context

Describe the bug

Update method does not correspond to what is stated in the API: https://app.lokalise.com/api2docs/curl/#

Request URL:

PUT https://api.lokalise.com/api2/projects/{project_id:branch}/translations/{translation_id}

Request Body:

{
    "translation": "Quick brown fox jumps over the lazy dog.",
    "is_unverified": false,
    "is_reviewed": true
}

But there is no is_unverified flag in go-lokalise client, there is an is_fuzzy flag instead:

type UpdateTranslation struct {
	Translation                string   `json:"translation"`
	IsFuzzy                    *bool    `json:"is_fuzzy,omitempty"`
	IsReviewed                 bool     `json:"is_reviewed,omitempty"`
	CustomTranslationStatusIDs []string `json:"custom_translation_status_ids,omitempty"`
}

To Reproduce

import github.com/lokalise/go-lokalise-api/v3

_, err := localiseClient.Translations().Update(projectID, translationID, lokalise.UpdateTranslation{
		Translation: translation,
		IsReviewed:  IsUnverified,
})

Expected behavior

import github.com/lokalise/go-lokalise-api/v3

_, err := localiseClient.Translations().Update(projectID, translationID, lokalise.UpdateTranslation{
		Translation: translation,
		IsUnverified:  IsUnverified, <-- there
})

Your environment:

• Go 1.18
• Client library version: v3.2.1

Additional context

Is it possible to update go-lokalise library for current version of the Lokalise API?

Documentation: https://lokalise.co/api2docs/go/#resource-languages

Endpoints

• List system languages (paginated)
• List project languages (paginated)
• Create languages
• Retrieve a language
• Update a language
• Delete a language

Documentation: https://lokalise.co/api2docs/go/#resource-comments

Endpoints

• List project comments (paginated)
• List key comments (paginated)
• Create comments
• Retrieve a comment
• Delete a comment

Documentation: https://lokalise.co/api2docs/curl/#resource-projects

Endpoints

• List all projects (paginated)
• Create a project
• Retrieve a project
• Update a project
• Empty project
• Delete a project

Documentation: https://lokalise.co/api2docs/curl/#transition-list-all-teams-get

Endpoints

• List all teams (paginated)

Documentation: https://lokalise.co/api2docs/go/#resource-contributors

Endpoints

• List all contributors (paginated)
• Create contributors
• Retrieve a contributor
• Update a contributor
• Delete a contributor

Documentation: https://lokalise.co/api2docs/go/#resource-translations

Endpoints

• List all translations (paginated)
• Retrieve a translation
• Update a translation

Is there any CI tooling available in your development setup that we can use e.g. CircleCI, Travis?

It would be great to have it running builds and unit tests (maybe even integration tests) on changes (and PRs)

Documentation: https://lokalise.co/api2docs/go/#resource-tasks

Endpoints

• List all tasks (paginated)
• Create a task
• Retrieve a task
• Update a task
• Delete a task