🔧 chore(docs): add Swagger documentation for the TMX import and export API endpoints#4589
Open
mauretto78 wants to merge 1 commit into
Open
🔧 chore(docs): add Swagger documentation for the TMX import and export API endpoints#4589mauretto78 wants to merge 1 commit into
mauretto78 wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds Swagger (OpenAPI v2) documentation entries for the TMX import/export endpoints in the v3 API, so they appear in /api/docs alongside the existing API surface.
Changes:
- Documented
POST /api/v3/tmx/import(multipart TMX upload). - Documented
POST /api/v3/tmx/export(request TMX export via email) under a newTMXtag.
Comment on lines
+4387
to
+4393
| name: 'name', | ||
| in: 'formData', | ||
| description: 'The name for the TM key.', | ||
| required: false, | ||
| type: 'string', | ||
| }, | ||
| { |
| name: 'tm_key', | ||
| in: 'formData', | ||
| description: | ||
| 'The TM key where the TMX will be imported. If not provided, the default MyMemory key will be used.', |
| tags: ['TMX'], | ||
| summary: 'Export TMX file', | ||
| description: | ||
| 'Request the export of a TMX file. The exported file will be sent via email. Requires authentication.', |
Comment on lines
+4446
to
+4469
| description: | ||
| 'Request the export of a TMX file. The exported file will be sent via email. Requires authentication.', | ||
| parameters: [ | ||
| { | ||
| name: 'tm_key', | ||
| in: 'formData', | ||
| description: 'The TM key to export.', | ||
| required: true, | ||
| type: 'string', | ||
| }, | ||
| { | ||
| name: 'tm_name', | ||
| in: 'formData', | ||
| description: 'The name of the TM.', | ||
| required: true, | ||
| type: 'string', | ||
| }, | ||
| { | ||
| name: 'email', | ||
| in: 'formData', | ||
| description: 'The email address to send the exported TMX to.', | ||
| required: false, | ||
| type: 'string', | ||
| }, |
🧪 Test-Guard Report❌ FAIL — Some changed source files lack adequate test coverage. Coverage Analysis: ❌ FAILNo changed source files found in coverage report (threshold: 80%) 📋 1 files: 1 ❌ fail
Test File Matching: ❌ FAILFile matching: 1 fail 📋 1 files: 1 ❌ fail
Per-File Evaluation: ❌ FAILAll files resolved by deterministic shortcuts. 📋 1 files: 1 ❌ fail
Result: ❌ FAIL Why this FAIL?
To resolve: add tests for public/api/swagger-source.js and update coverage configuration to include it in reports. |
Ostico
changed the title
Ostico
changed the title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Add Swagger documentation for the TMX import and export API endpoints.
Type
chore— build, deps, config, docsChanges
Testing
Opened API docs page (
/api/docs)AI Disclosure