diff --git a/articles/LCPublicAPI/api/Public-API.v1.json b/articles/LCPublicAPI/api/Public-API.v1.json index 1810439..655f7a1 100644 --- a/articles/LCPublicAPI/api/Public-API.v1.json +++ b/articles/LCPublicAPI/api/Public-API.v1.json @@ -1850,7 +1850,7 @@ "/files": { "post": { "summary": "Upload Zip File", - "description": "Uploads an archive containing source files in `.zip` format, which will be extracted and used during project creation.\n\nStatus of the upload operation can be tracked using the [Poll Upload Zip File](#/operations/PollUploadZipFile) endpoint.\n\nOnce this Upload Zip File operation has finished extracting the files, they can be added to the desired project using the [Attach Source Files](#/operations/AddSourceFiles) endpoint. Alternatively, they can be used to [Request File Analysis](#/operations/RequestFileAnalysis) details like word counts and estimated costs.\n\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", + "description": "Uploads an archive containing source files in `.zip` format, which will be extracted and used during project creation.\n\nStatus of the upload operation can be tracked using the [Poll Upload Zip File](Public-API.v1-fv.html#/operations/PollUploadZipFile) endpoint.\n\nOnce this Upload Zip File operation has finished extracting the files, they can be added to the desired project using the [Attach Source Files](Public-API.v1-fv.html#/operations/AddSourceFiles) endpoint. Alternatively, they can be used to [Request File Analysis](Public-API.v1-fv.html#/operations/RequestFileAnalysis) details like word counts and estimated costs.\n\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "operationId": "UploadZipFile", "requestBody": { "content": { @@ -2109,7 +2109,7 @@ } } }, - "description": "This endpoint allows you to request the word count and an estimated cost for your files. \r\n\r\nUse the [Upload Zip File](#/operations/UploadZipFile) / [Poll Upload Zip File](#/operations/PollUploadZipFile) endpoints to upload your files and get the `fileIds`. Send these `fileIds` together with the `languageProcessingRuleId` and `sourceLanguage` to receive the word count.\r\n\r\nOptionally, send the `quotingOptions` object to receive the `estimatedCosts`.\r\n\r\nUse the [Poll File Analysis](#/operations/PollFileAnalysis) endpoint to monitor the operation and receive the analysis results.\r\n\r\n> File analysis results will be available for 24 hours after generation.", + "description": "This endpoint allows you to request the word count and an estimated cost for your files. \r\n\r\nUse the [Upload Zip File](Public-API.v1-fv.html#/operations/UploadZipFile) / [Poll Upload Zip File](Public-API.v1-fv.html#/operations/PollUploadZipFile) endpoints to upload your files and get the `fileIds`. Send these `fileIds` together with the `languageProcessingRuleId` and `sourceLanguage` to receive the word count.\r\n\r\nOptionally, send the `quotingOptions` object to receive the `estimatedCosts`.\r\n\r\nUse the [Poll File Analysis](Public-API.v1-fv.html#/operations/PollFileAnalysis) endpoint to monitor the operation and receive the analysis results.\r\n\r\n> File analysis results will be available for 24 hours after generation.", "tags": [ "File" ] @@ -2222,7 +2222,7 @@ "$ref": "#/components/parameters/fields" } ], - "description": "Monitor the [File Analysis](#/operations/RequestFileAnalysis) operation and receive the analysis results.\r\n\r\n> File analysis results will be available for 24 hours after generation.", + "description": "Monitor the [File Analysis](Public-API.v1-fv.html#/operations/RequestFileAnalysis) operation and receive the analysis results.\r\n\r\n> File analysis results will be available for 24 hours after generation.", "tags": [ "File" ] @@ -2313,7 +2313,7 @@ "$ref": "#/components/parameters/X-LC-Tenant" } ], - "description": "Monitors the unzipping operation for a previously uploaded archive and retrieves details about the extracted files.\r\n\r\nOnce the [Upload Zip File](#/operations/UploadZipFile) operation has finished extracting the files, they can be added to the desired project using the [Attach Source Files](#/operations/AddSourceFiles) endpoint.\r\n Alternatively, they can be used to [Request File Analysis](#/operations/RequestFileAnalysis) details like word counts and estimated costs.\r\n", + "description": "Monitors the unzipping operation for a previously uploaded archive and retrieves details about the extracted files.\r\n\r\nOnce the [Upload Zip File](Public-API.v1-fv.html#/operations/UploadZipFile) operation has finished extracting the files, they can be added to the desired project using the [Attach Source Files](Public-API.v1-fv.html#/operations/AddSourceFiles) endpoint.\r\n Alternatively, they can be used to [Request File Analysis](Public-API.v1-fv.html#/operations/RequestFileAnalysis) details like word counts and estimated costs.\r\n", "tags": [ "File" ] @@ -3187,7 +3187,7 @@ "x-stoplight": { "id": "thyh9npsnqozm" }, - "description": "For more details on the PerfectMatch feature please consult the [official documentation](https://docs.rws.com/791595/1155478/trados-enterprise---accelerate/perfectmatch-general-information).\r\n\r\nAfter creating a mapping, target files from the `matchingProjects` are automatically matched to the source files in the new project. This is a long-running background operation, and its `status` can be tracked by polling the [Get PerfectMatch Mapping](#/operations/GetPerfectMatchMapping) endpoint.", + "description": "For more details on the PerfectMatch feature please consult the [official documentation](https://docs.rws.com/791595/1155478/trados-enterprise---accelerate/perfectmatch-general-information).\r\n\r\nAfter creating a mapping, target files from the `matchingProjects` are automatically matched to the source files in the new project. This is a long-running background operation, and its `status` can be tracked by polling the [Get PerfectMatch Mapping](Public-API.v1-fv.html#/operations/GetPerfectMatchMapping) endpoint.", "requestBody": { "content": { "application/json": { @@ -3724,7 +3724,7 @@ } } }, - "description": "Updates a PerfectMatch file mapping with an existing target file from a PerfectMatch candidate. Only valid candidates can be used to request an update.\r\n\r\nUse the [Candidates](#/operations/GetPerfectMatchCandidates) endpoint to retrieve a list of valid `fileId` and `projectId` to provide as matching data. " + "description": "Updates a PerfectMatch file mapping with an existing target file from a PerfectMatch candidate. Only valid candidates can be used to request an update.\r\n\r\nUse the [Candidates](Public-API.v1-fv.html#/operations/GetPerfectMatchCandidates) endpoint to retrieve a list of valid `fileId` and `projectId` to provide as matching data. " } }, "/perfect-match-mappings/{mappingId}/batch-mappings/{batchMappingId}/file-mappings/{fileMappingId}/file": { @@ -6199,7 +6199,7 @@ "Project" ], "summary": "Download Exported Project Files", - "description": "Downloads the generated `zip` file containing the files according to initial export operation parameters. \n\nThe final ZIP file will be named using the project name. \n\n When the export operation is performed with `downloadFlat=true` and one target language specified, the resulting ZIP file name will be a combination of the project name and the target language code, as defined by the [Export Project Files](#/operations/ExportProjectFiles) endpoint.", + "description": "Downloads the generated `zip` file containing the files according to initial export operation parameters. \n\nThe final ZIP file will be named using the project name. \n\n When the export operation is performed with `downloadFlat=true` and one target language specified, the resulting ZIP file name will be a combination of the project name and the target language code, as defined by the [Export Project Files](Public-API.v1-fv.html#/operations/ExportProjectFiles) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -6454,7 +6454,7 @@ "Source File" ], "summary": "Add Source File", - "description": "Adds a source file to the project. Files can be uploaded before starting a project or after the project has started. When adding a `translatable` file after the project started, a new start project request should be performed.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n\n> Note: Zip files will be added as reference files. If you want to upload zip files, please use the [Upload Zip File](#/operations/UploadZipFile) endpoint.", + "description": "Adds a source file to the project. Files can be uploaded before starting a project or after the project has started. When adding a `translatable` file after the project started, a new start project request should be performed.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n\n> Note: Zip files will be added as reference files. If you want to upload zip files, please use the [Upload Zip File](Public-API.v1-fv.html#/operations/UploadZipFile) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -6669,7 +6669,7 @@ "Source File" ], "summary": "Attach Source Files", - "description": "This endpoint can only be used after files have been uploaded via the [Upload Zip File](#/operations/UploadZipFile) endpoint. It allows you to add multiple source files to a project. \n\n Each file must be individually attached by setting the `fileUrl` to the `associatedFiles.id` returned by the [Poll Upload Zip File](#/operations/PollUploadZipFile) endpoint, once the `unzipStatus` is `extracted`. \n\nIf a file is attached after the project has already been started, a new start project request must be made.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n", + "description": "This endpoint can only be used after files have been uploaded via the [Upload Zip File](Public-API.v1-fv.html#/operations/UploadZipFile) endpoint. It allows you to add multiple source files to a project. \n\n Each file must be individually attached by setting the `fileUrl` to the `associatedFiles.id` returned by the [Poll Upload Zip File](Public-API.v1-fv.html#/operations/PollUploadZipFile) endpoint, once the `unzipStatus` is `extracted`. \n\nIf a file is attached after the project has already been started, a new start project request must be made.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -7230,7 +7230,7 @@ }, "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, - "description": "Adds a new version of the source file in [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) or native format. More information about file formats can be found on the [File formats](../docs/File-formats.html) page.\n\nThe version is added on the task represented by `taskId`. To successfully execute the add operation the task should already be assigned and accepted by a user. If the task is automatic, it's possible to add a source file version only when the status of task is `inProgress`.\n\nThe file versions added need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a source file version using an extension task, the configuration of the task must declare the `scope`'s value as \"file\".\n\nIf the file type of the new added file is different than the supported source file type, the new `fileTypeSettingsId` must be specified in the body or an update of file type should be performed after the add operation, using the [Update Source File Properties](#/operations/UpdateSourceProperties).\n\nThe value of `fileTypeSettingsId` is one of the identifiers listed by the [List File Type Settings](#/operations/ListFileTypeSettings) endpoint.\n\nThe [List File Type Settings](#/operations/ListFileTypeSettings) endpoint must be called with the File Processing Configuration identifier of your project.\n\nThe File Processing Configuration of your project can be retrieved from [Get Project](#/operations/GetProject) endpoint.\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation. \n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when adding files.\n", + "description": "Adds a new version of the source file in [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) or native format. More information about file formats can be found on the [File formats](../docs/File-formats.html) page.\n\nThe version is added on the task represented by `taskId`. To successfully execute the add operation the task should already be assigned and accepted by a user. If the task is automatic, it's possible to add a source file version only when the status of task is `inProgress`.\n\nThe file versions added need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a source file version using an extension task, the configuration of the task must declare the `scope`'s value as \"file\".\n\nIf the file type of the new added file is different than the supported source file type, the new `fileTypeSettingsId` must be specified in the body or an update of file type should be performed after the add operation, using the [Update Source File Properties](Public-API.v1-fv.html#/operations/UpdateSourceProperties).\n\nThe value of `fileTypeSettingsId` is one of the identifiers listed by the [List File Type Settings](Public-API.v1-fv.html#/operations/ListFileTypeSettings) endpoint.\n\nThe [List File Type Settings](Public-API.v1-fv.html#/operations/ListFileTypeSettings) endpoint must be called with the File Processing Configuration identifier of your project.\n\nThe File Processing Configuration of your project can be retrieved from [Get Project](Public-API.v1-fv.html#/operations/GetProject) endpoint.\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation. \n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when adding files.\n", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -7542,7 +7542,7 @@ } } }, - "description": "Updates the properties of the source file.\n\n\nThe value of `fileTypeSettingsId` should be one of the identifiers listed by the [List File Type Settings](#/operations/ListFileTypeSettings) endpoint called with an identifier of a File Processing Configuration that exists on the project. The list of File Processing Configurations from a project can be retrieved by using the [List File Processing Configurations](#/operations/ListFileProcessingConfigurations) endpoint.", + "description": "Updates the properties of the source file.\n\n\nThe value of `fileTypeSettingsId` should be one of the identifiers listed by the [List File Type Settings](Public-API.v1-fv.html#/operations/ListFileTypeSettings) endpoint called with an identifier of a File Processing Configuration that exists on the project. The list of File Processing Configurations from a project can be retrieved by using the [List File Processing Configurations](Public-API.v1-fv.html#/operations/ListFileProcessingConfigurations) endpoint.", "requestBody": { "content": { "application/json": { @@ -8219,7 +8219,7 @@ "Target File" ], "summary": "Export Target File Version", - "description": "Generates an asynchronous export operation. Use the [Get Target File Version Export](#/operations/PollTargetFileVersionExport) endpoint to poll until the export is completed. Used only for [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) file versions.\n\nThis operation triggers a conversion of the BCM target file version in a native or SDLXLIFF format, based on the value of the `format` query parameter used.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", + "description": "Generates an asynchronous export operation. Use the [Get Target File Version Export](Public-API.v1-fv.html#/operations/PollTargetFileVersionExport) endpoint to poll until the export is completed. Used only for [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) file versions.\n\nThis operation triggers a conversion of the BCM target file version in a native or SDLXLIFF format, based on the value of the `format` query parameter used.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -8656,7 +8656,7 @@ "Target File" ], "summary": "Import Target File Version", - "description": "Generates an asynchronous import operation. Use [Poll Target File Version Import endpoint](#/operations/PollTargetFileVersionImport) to poll until the import is completed. Only `sdlxliff` files can be imported.\n\nImport should be used when a file is downloaded as an `sdlxliff`, processed and then, replaced. \nThe import operation triggers internally the update of the [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) file associated with the imported file. It should mostly be used for offline work.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", + "description": "Generates an asynchronous import operation. Use [Poll Target File Version Import endpoint](Public-API.v1-fv.html#/operations/PollTargetFileVersionImport) to poll until the import is completed. Only `sdlxliff` files can be imported.\n\nImport should be used when a file is downloaded as an `sdlxliff`, processed and then, replaced. \nThe import operation triggers internally the update of the [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) file associated with the imported file. It should mostly be used for offline work.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -8995,7 +8995,7 @@ }, "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, - "description": "Adds a new version of the target file. Only the `native` and `bcm` file formats are accepted. For the `sdlxliff` files, you should use the [Import Target File endpoint](#/operations/ImportTargetFileVersion). More information about file formats can be found on the [File formats](../docs/File-formats.html) page. Additional details on BCM files can be found [here](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html).\n\nThe version is added on the task represented by `taskId`. To be able to execute the add operation the task should be assigned and accepted by user. If the task is automatic, it is possible to add a target file version only if the status is `inProgress`.\n\nThe added file versions need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a target file version using an extension task, the configuration of the task type must declare the `scope`'s value as \"file\".\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", + "description": "Adds a new version of the target file. Only the `native` and `bcm` file formats are accepted. For the `sdlxliff` files, you should use the [Import Target File endpoint](Public-API.v1-fv.html#/operations/ImportTargetFileVersion). More information about file formats can be found on the [File formats](../docs/File-formats.html) page. Additional details on BCM files can be found [here](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html).\n\nThe version is added on the task represented by `taskId`. To be able to execute the add operation the task should be assigned and accepted by user. If the task is automatic, it is possible to add a target file version only if the status is `inProgress`.\n\nThe added file versions need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a target file version using an extension task, the configuration of the task type must declare the `scope`'s value as \"file\".\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -9084,7 +9084,7 @@ } } }, - "description": "Cancels a project file.\n\nThe `fileId` path parameter can be either a source file identifier or a target file identifier. Use the [List Source Files](#/operations/ListSourceFiles) endpoint to obtain source file identifiers, or the [List Target Files](#/operations/ListTargetFiles) endpoint to obtain target file identifiers.", + "description": "Cancels a project file.\n\nThe `fileId` path parameter can be either a source file identifier or a target file identifier. Use the [List Source Files](Public-API.v1-fv.html#/operations/ListSourceFiles) endpoint to obtain source file identifiers, or the [List Target Files](Public-API.v1-fv.html#/operations/ListTargetFiles) endpoint to obtain target file identifiers.", "tags": [ "Project" ], @@ -9423,7 +9423,7 @@ } } }, - "description": "Downloads a quote report generated by the [asynchronous export operation](#/operations/ExportQuoteReport). \n\nIf the `exportId` query parameter is not provided, the last generated export quote will be downloaded.", + "description": "Downloads a quote report generated by the [asynchronous export operation](Public-API.v1-fv.html#/operations/ExportQuoteReport). \n\nIf the `exportId` query parameter is not provided, the last generated export quote will be downloaded.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -10130,7 +10130,7 @@ "Project Group" ], "summary": "Add Projects To Group", - "description": "Adds projects to the project group.\n\nThe projects are not added instantly. To check the status use the [Get Project Group](#/operations/GetProjectGroup) endpoint.", + "description": "Adds projects to the project group.\n\nThe projects are not added instantly. To check the status use the [Get Project Group](Public-API.v1-fv.html#/operations/GetProjectGroup) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -10251,7 +10251,7 @@ "Project Group" ], "summary": "Remove Projects From Group", - "description": "Removes projects from the project group.\n\nThe projects are not removed instantly. To check the status use the [Get Project Group](#/operations/GetProjectGroup) endpoint.", + "description": "Removes projects from the project group.\n\nThe projects are not removed instantly. To check the status use the [Get Project Group](Public-API.v1-fv.html#/operations/GetProjectGroup) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -15309,7 +15309,7 @@ } } }, - "description": "Generates an asynchronous export operation.
\nUse the [Poll Export Termbase](#/operations/PollExportTermbase) endpoint to poll until the export status is `done`.", + "description": "Generates an asynchronous export operation.
\nUse the [Poll Export Termbase](Public-API.v1-fv.html#/operations/PollExportTermbase) endpoint to poll until the export status is `done`.", "tags": [ "Termbase Export" ] @@ -17371,7 +17371,7 @@ }, "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, - "description": "Generates an asynchronous import operation. \n
\n
Read more about prerequisites and limitations on the [official documentation center](https://docs.rws.com/791595/741139/trados-enterprise/importing-tm-content).\n
\nNote: The order of the multipart form parameter must be implemented as such: properties first, file second.\n
\nUse the Poll Translation Memory Import endpoint to poll until the import status is `done`.
\nTo track the progress of the import please refer to [Poll Translation Memory Import](#/operations/PollTMImport).", + "description": "Generates an asynchronous import operation. \n
\n
Read more about prerequisites and limitations on the [official documentation center](https://docs.rws.com/791595/741139/trados-enterprise/importing-tm-content).\n
\nNote: The order of the multipart form parameter must be implemented as such: properties first, file second.\n
\nUse the Poll Translation Memory Import endpoint to poll until the import status is `done`.
\nTo track the progress of the import please refer to [Poll Translation Memory Import](Public-API.v1-fv.html#/operations/PollTMImport).", "tags": [ "Translation Memory Import" ] @@ -17577,7 +17577,7 @@ } } }, - "description": "Generates an asynchronous export operation.\nUse the [Poll Translation Memory Export](#/operations/PollTranslationMemoryExport) endpoint to poll until the export status is `done`.", + "description": "Generates an asynchronous export operation.\nUse the [Poll Translation Memory Export](Public-API.v1-fv.html#/operations/PollTranslationMemoryExport) endpoint to poll until the export status is `done`.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -33622,3 +33622,4 @@ } } } + diff --git a/scripts/convert-contract-links.ps1 b/scripts/convert-contract-links.ps1 index 56ef915..3c4c344 100644 --- a/scripts/convert-contract-links.ps1 +++ b/scripts/convert-contract-links.ps1 @@ -128,7 +128,9 @@ foreach ($cf in $contractFiles) { $url = $m.Groups[2].Value # Skip absolute URLs (http, https, mailto) - if ($url -match '^(https?:|mailto:|#)') { continue } + if ($url -match '^(https?:|mailto:)') { continue } + # Skip fragments that are NOT operations or schemas + if ($url -match '^#' -and $url -notmatch '^#/(operations|schemas)/') { continue } $newUrl = $null @@ -177,7 +179,8 @@ foreach ($cf in $contractFiles) { } if ($isLocalContract) { - $newUrl = "#/operations/$opId" + $jsonName = [System.IO.Path]::GetFileNameWithoutExtension($refFile) + $newUrl = "$jsonName-fv.html#/operations/$opId" } else { # compute relative path from current file to referenced file's folder $refDir = Split-Path -Path $resolved -Parent @@ -201,7 +204,8 @@ foreach ($cf in $contractFiles) { elseif ($rest -like 'components/schemas/*') { $schema = $rest -replace '^components/schemas/','' if ($isLocalContract) { - $newUrl = "#/schemas/$schema" + $jsonName = [System.IO.Path]::GetFileNameWithoutExtension($refFile) + $newUrl = "$jsonName-fv.html#/schemas/$schema" } else { $refDir = Split-Path -Path $resolved -Parent $refHtmlFile = [System.IO.Path]::Combine($refDir, ([System.IO.Path]::GetFileNameWithoutExtension($refFile) + '-fv.html')) @@ -223,6 +227,15 @@ foreach ($cf in $contractFiles) { } } + # Case 3: Upgrade existing local fragments to full-view filenames + elseif ($url -match '^#/(operations|schemas)/(.+)$') { + $type = $Matches[1] + $id = $Matches[2] + $jsonName = [System.IO.Path]::GetFileNameWithoutExtension($cf) + $newUrl = "$jsonName-fv.html#/$type/$id" + $report += [pscustomobject]@{ File = $cf; Old = $url; New = $newUrl; Reason = 'fragment -> full-view' } + } + if ($newUrl) { # literal replace the url inside the JSON content $escapedOld = [Regex]::Escape($url)