-
Notifications
You must be signed in to change notification settings - Fork 7
Add Generate Translations utility endpoint #53
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.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bryantgillespie
wants to merge
2
commits into
main
Choose a base branch
from
bry/gen-translations-collection
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+108
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| post: | ||
| $ref: translations-generate.yaml |
104 changes: 104 additions & 0 deletions
104
openapi/paths/utils/translations/generate/translations-generate.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,104 @@ | ||||||
| summary: Generate Translations Collection | ||||||
| description: Creates the full translations infrastructure (collections, fields, relationships) for a given source collection. Requires administrator access. | ||||||
| operationId: translations-generate | ||||||
| requestBody: | ||||||
| content: | ||||||
| application/json: | ||||||
| schema: | ||||||
| type: object | ||||||
| properties: | ||||||
| collection: | ||||||
| type: string | ||||||
| description: The source collection to enable translations for. | ||||||
| example: articles | ||||||
| fields: | ||||||
| type: array | ||||||
| items: | ||||||
| type: string | ||||||
| minItems: 1 | ||||||
| description: Field names from the source collection to make translatable. | ||||||
| example: | ||||||
| - title | ||||||
| - content | ||||||
| translationsCollection: | ||||||
| type: string | ||||||
| description: Custom name for the translations junction collection. Defaults to `{collection}_translations`. | ||||||
| languagesCollection: | ||||||
| type: string | ||||||
| description: Name of the languages collection to use or create. Defaults to `languages`. | ||||||
| parentFkField: | ||||||
| type: string | ||||||
| description: Custom name for the foreign key field referencing the source collection. | ||||||
| languageFkField: | ||||||
| type: string | ||||||
| description: Custom name for the foreign key field referencing the languages collection. | ||||||
| createLanguagesCollection: | ||||||
| type: boolean | ||||||
| default: true | ||||||
| description: Whether to create the languages collection if it does not exist. | ||||||
| seedLanguages: | ||||||
| type: boolean | ||||||
| default: true | ||||||
| description: Whether to seed the languages collection with common languages when creating it. | ||||||
| required: | ||||||
| - collection | ||||||
| - fields | ||||||
| responses: | ||||||
| '200': | ||||||
| content: | ||||||
| application/json: | ||||||
| schema: | ||||||
| type: object | ||||||
| properties: | ||||||
| data: | ||||||
| oneOf: | ||||||
| - type: object | ||||||
| title: Created | ||||||
| description: Returned when a new translations collection is created. | ||||||
| properties: | ||||||
| created: | ||||||
| type: boolean | ||||||
| enum: | ||||||
| - true | ||||||
| translationsCollection: | ||||||
| type: string | ||||||
| example: articles_translations | ||||||
| languagesCollection: | ||||||
| type: string | ||||||
| example: languages | ||||||
| fields: | ||||||
| type: array | ||||||
| items: | ||||||
| type: string | ||||||
| example: | ||||||
| - title | ||||||
| - content | ||||||
| required: | ||||||
| - created | ||||||
| - translationsCollection | ||||||
| - languagesCollection | ||||||
| - fields | ||||||
| - type: object | ||||||
| title: Fields Added | ||||||
| description: Returned when fields are added to an existing translations collection. | ||||||
| properties: | ||||||
| created: | ||||||
| type: boolean | ||||||
| enum: | ||||||
| - false | ||||||
| translationsCollection: | ||||||
| type: string | ||||||
| example: articles_translations | ||||||
| fields: | ||||||
| type: array | ||||||
| items: | ||||||
| type: string | ||||||
| example: | ||||||
| - summary | ||||||
| required: | ||||||
| - created | ||||||
| - translationsCollection | ||||||
| - fields | ||||||
| description: Successful request | ||||||
| tags: | ||||||
| - Utilities | ||||||
|
||||||
| - Utilities | |
| - Utilities |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new utils endpoint is missing the
security: []field that other utility operations consistently include (e.g.,openapi/paths/utils/hash/generate/hash-generate.yamlandopenapi/paths/utils/cache/clear/clear-cache.yaml). Please add it for consistency with the existing OpenAPI operation objects in this repo.