backend: allow for source lang to be overridden in note/translate #160

Manually merged

norm merged 2 commits from backend-translate-source-lang into main 2022-09-21 03:56:24 +00:00

Conversation 6 Commits 2 Files changed 2 +81 -4

norm commented 2022-09-17 19:03:15 +00:00

Owner

Copy link

This adds a new optional sourceLang parameter to the notes/translate
endpoint. If not set, the old behaviour is used, else this sets the
source_lang parameter to the DeepL API call which makes it use the
source language specified instead of using autodetection.

Changelog: Changed
Ref: #33

This adds a new optional `sourceLang` parameter to the `notes/translate` endpoint. If not set, the old behaviour is used, else this sets the `source_lang` parameter to the DeepL API call which makes it use the source language specified instead of using autodetection. Changelog: Changed Ref: https://akkoma.dev/FoundKeyGang/FoundKey/issues/33

norm commented 2022-09-17 19:04:31 +00:00

Author

Owner

Copy link

This will only contain the backend part as I'm still not decided on how it'll be done on the frontend.

This will only contain the backend part as I'm still not decided on how it'll be done on the frontend.

norm force-pushed backend-translate-source-lang from e2ac97a5fc to 644c423643 2022-09-17 19:05:22 +00:00 Compare

Johann150 commented 2022-09-17 20:47:22 +00:00

Owner

Copy link

If this is supposed to cover all the backend parts of #33, you'll need to adjust the target language part too, to accept EN-GB and EN-US as well as PT-BR and PT-PT. (see also https://www.deepl.com/docs-api/translate-text/translate-text/)

If this is supposed to cover all the backend parts of #33, you'll need to adjust the target language part too, to accept `EN-GB` and `EN-US` as well as `PT-BR` and `PT-PT`. (see also <https://www.deepl.com/docs-api/translate-text/translate-text/>)

Johann150 commented 2022-09-17 20:51:16 +00:00

Owner

Copy link

If you want to be extra strict you could add enum validation to source and target language as well.

If you want to be extra strict you could add `enum` validation to source and target language as well.

norm commented 2022-09-18 00:29:14 +00:00

Author

Owner

Copy link

Not sure if what I came up with was what you had in mind, but I'm not sure if there's a better way (still kinda new to this sort of stuff).

Not sure if what I came up with was what you had in mind, but I'm not sure if there's a better way (still kinda new to this sort of stuff).

Johann150 commented 2022-09-18 18:59:40 +00:00

Owner

Copy link

No, sorry that is not what I meant. You can use the JSON schema enum key of the endpoint in paramDef to make use of the existing validation. Something like this:

export const paramDef = {
	// ...
	properties: {
		// ...
		sourceLang: {
			type: 'string',
			enum: ['BG', 'CS', 'DA', 'DE', 'EL', /* etc. */ ],
		},
		// similar for targetLang
	},
} as const;

No, sorry that is not what I meant. You can use the [JSON schema `enum` key](https://ajv.js.org/json-schema.html#enum) of the endpoint in `paramDef` to make use of the existing validation. Something like this: ```typescript export const paramDef = { // ... properties: { // ... sourceLang: { type: 'string', enum: ['BG', 'CS', 'DA', 'DE', 'EL', /* etc. */ ], }, // similar for targetLang }, } as const; ```

norm commented 2022-09-18 19:01:24 +00:00

Author

Owner

Copy link

oh that makes MUCH more sense.

oh that makes MUCH more sense.

norm force-pushed backend-translate-source-lang from 6875a47fbb to c068294c51 2022-09-19 14:49:09 +00:00 Compare

norm force-pushed backend-translate-source-lang from c068294c51 to d5d8affc33 2022-09-19 14:57:21 +00:00 Compare

Johann150 added 1 commit 2022-09-19 20:22:03 +00:00

client: bring targetLang into correct format ... 17f3dafd6b

Now that stricter API validation has been added, it will be necessary
to modify the target language in the client so the API will not fail
with a validation error.

norm referenced this pull request from a commit 2022-09-21 03:56:20 +00:00

Merge branch 'backend-translate-source-lang'

norm manually merged commit 78fd2ee38b into main 2022-09-21 03:56:24 +00:00

norm deleted branch backend-translate-source-lang 2022-09-21 04:02:12 +00:00

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

feature

task that proposes new feature(s)

  

fix

task to fix behavioral problems in the FoundKey codebase

  

upkeep

task that should make FoundKey smaller and more maintainable

No labels

feature

fix

upkeep

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

2 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: FoundKeyGang/FoundKey#160

No description provided.