Skip to content

Commit

Permalink
chore: update API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
crowdin-bot authored and andrii-bodnar committed Dec 10, 2024
1 parent 727c63d commit b65fa73
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 160 deletions.
88 changes: 8 additions & 80 deletions src/assets/api/crowdin/file-based.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31282,14 +31282,8 @@ components:
type: boolean
default: false
example: true
skipUntranslatedStrings:
description: "Defines whether to export only translated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false`, `type=0` or `type=2` in same request"
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
Expand Down Expand Up @@ -31373,14 +31367,8 @@ components:
type: boolean
default: false
example: true
skipUntranslatedStrings:
description: "Defines whether to export only translated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false`, `type=0` or `type=2` in same request"
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
Expand Down Expand Up @@ -31479,23 +31467,11 @@ components:
description:
description: 'Task description'
type: string
skipUntranslatedStrings:
description: "Defines whether to include only translated strings\n\n__Note:__ `true` value can't be used with `includeUntranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to include only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false` or `includeUntranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
includeUntranslatedStringsOnly:
description: "Defines whether to include only untranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=true` or `includePreTranslatedStringsOnly=true` in same request"
description: 'Defines whether to include only pretranslated strings'
type: boolean
default: false
example: true
deprecated: true
dateFrom:
description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601"
type: string
Expand Down Expand Up @@ -31548,23 +31524,11 @@ components:
description:
description: 'Task description'
type: string
skipUntranslatedStrings:
description: "Defines whether to include only translated strings\n\n__Note:__ `true` value can't be used with `includeUntranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to include only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false` or `includeUntranslatedStringsOnly=true` in same request"
description: 'Defines whether to include only pretranslated strings'
type: boolean
default: false
example: true
includeUntranslatedStringsOnly:
description: "Defines whether to include only untranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=true` or `includePreTranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
deprecated: true
dateFrom:
description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601"
type: string
Expand Down Expand Up @@ -31673,23 +31637,11 @@ components:
type: boolean
default: false
example: 'true'
skipUntranslatedStrings:
description: "Defines whether to include only translated strings\n\n__Note:__ `true` value can't be used with `includeUntranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to include only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false` or `includeUntranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
includeUntranslatedStringsOnly:
description: "Defines whether to include only untranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=true` or `includePreTranslatedStringsOnly=true` in same request"
description: 'Defines whether to include only pretranslated strings'
type: boolean
default: false
example: true
deprecated: true
dateFrom:
description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601"
type: string
Expand Down Expand Up @@ -31768,23 +31720,11 @@ components:
type: boolean
default: false
example: 'true'
skipUntranslatedStrings:
description: "Defines whether to include only translated strings\n\n__Note:__ `true` value can't be used with `includeUntranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to include only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false` or `includeUntranslatedStringsOnly=true` in same request"
description: 'Defines whether to include only pretranslated strings'
type: boolean
default: false
example: true
includeUntranslatedStringsOnly:
description: "Defines whether to include only untranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=true` or `includePreTranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
deprecated: true
dateFrom:
description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601"
type: string
Expand Down Expand Up @@ -32089,14 +32029,8 @@ components:
type: boolean
default: false
example: true
skipUntranslatedStrings:
description: "Defines whether to export only translated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false`, `type=0` or `type=2` in same request"
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
Expand Down Expand Up @@ -32172,14 +32106,8 @@ components:
type: boolean
default: false
example: true
skipUntranslatedStrings:
description: "Defines whether to export only translated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false`, `type=0` or `type=2` in same request"
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
Expand Down
88 changes: 8 additions & 80 deletions src/assets/api/crowdin/string-based.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29820,14 +29820,8 @@ components:
type: boolean
default: false
example: true
skipUntranslatedStrings:
description: "Defines whether to export only translated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false`, `type=0` or `type=2` in same request"
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
Expand Down Expand Up @@ -29903,14 +29897,8 @@ components:
type: boolean
default: false
example: true
skipUntranslatedStrings:
description: "Defines whether to export only translated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false`, `type=0` or `type=2` in same request"
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
Expand Down Expand Up @@ -30009,23 +29997,11 @@ components:
description:
description: 'Task description'
type: string
skipUntranslatedStrings:
description: "Defines whether to include only translated strings\n\n__Note:__ `true` value can't be used with `includeUntranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to include only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false` or `includeUntranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
includeUntranslatedStringsOnly:
description: "Defines whether to include only untranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=true` or `includePreTranslatedStringsOnly=true` in same request"
description: 'Defines whether to include only pretranslated strings'
type: boolean
default: false
example: true
deprecated: true
dateFrom:
description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601"
type: string
Expand Down Expand Up @@ -30078,23 +30054,11 @@ components:
description:
description: 'Task description'
type: string
skipUntranslatedStrings:
description: "Defines whether to include only translated strings\n\n__Note:__ `true` value can't be used with `includeUntranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to include only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false` or `includeUntranslatedStringsOnly=true` in same request"
description: 'Defines whether to include only pretranslated strings'
type: boolean
default: false
example: true
includeUntranslatedStringsOnly:
description: "Defines whether to include only untranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=true` or `includePreTranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
deprecated: true
dateFrom:
description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601"
type: string
Expand Down Expand Up @@ -30203,23 +30167,11 @@ components:
type: boolean
default: false
example: 'true'
skipUntranslatedStrings:
description: "Defines whether to include only translated strings\n\n__Note:__ `true` value can't be used with `includeUntranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to include only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false` or `includeUntranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
includeUntranslatedStringsOnly:
description: "Defines whether to include only untranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=true` or `includePreTranslatedStringsOnly=true` in same request"
description: 'Defines whether to include only pretranslated strings'
type: boolean
default: false
example: true
deprecated: true
dateFrom:
description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601"
type: string
Expand Down Expand Up @@ -30298,23 +30250,11 @@ components:
type: boolean
default: false
example: 'true'
skipUntranslatedStrings:
description: "Defines whether to include only translated strings\n\n__Note:__ `true` value can't be used with `includeUntranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to include only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false` or `includeUntranslatedStringsOnly=true` in same request"
description: 'Defines whether to include only pretranslated strings'
type: boolean
default: false
example: true
includeUntranslatedStringsOnly:
description: "Defines whether to include only untranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=true` or `includePreTranslatedStringsOnly=true` in same request"
type: boolean
default: false
example: true
deprecated: true
dateFrom:
description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601"
type: string
Expand Down Expand Up @@ -30619,14 +30559,8 @@ components:
type: boolean
default: false
example: true
skipUntranslatedStrings:
description: "Defines whether to export only translated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false`, `type=0` or `type=2` in same request"
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
Expand Down Expand Up @@ -30702,14 +30636,8 @@ components:
type: boolean
default: false
example: true
skipUntranslatedStrings:
description: "Defines whether to export only translated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
deprecated: true
includePreTranslatedStringsOnly:
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=false`, `type=0` or `type=2` in same request"
description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request"
type: boolean
default: false
example: true
Expand Down

0 comments on commit b65fa73

Please sign in to comment.