Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
301 changes: 32 additions & 269 deletions articles/Extensibility/api/Extensibility-API.v1.json

Large diffs are not rendered by default.

4 changes: 0 additions & 4 deletions articles/Extensibility/docs/appManagement/Approvals.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
stoplight-id: f0cb88dbb2089
---

# Approvals and Support Communication

## Approval Process
Expand Down
4 changes: 0 additions & 4 deletions articles/Extensibility/docs/appManagement/Foreword.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
stoplight-id: 015bfda96d1a6
---

# Foreword

This section is about managing apps in RWS Trados and it is dedicated to developers.
Expand Down
5 changes: 0 additions & 5 deletions articles/Extensibility/docs/appManagement/Installing.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
stoplight-id: hspobp79yp423
---


# Installing the App

After the app is successfully registered, you can proceed to install it. The installation is tenant-based, which means that all users in the tenant will be able to use the app.
Expand Down
4 changes: 0 additions & 4 deletions articles/Extensibility/docs/appManagement/Publishing.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
stoplight-id: 220f6cf2449fe
---

# Publishing the App

The publish operation makes your app publicly available in the **RWS AppStore**, allowing other tenants to install and use it.
Expand Down
4 changes: 0 additions & 4 deletions articles/Extensibility/docs/appManagement/Registering.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
stoplight-id: 7295d1d88211f
---

# Registering the App

Registration is the first step in integrating your app into the Trados platform.
Expand Down
5 changes: 0 additions & 5 deletions articles/Extensibility/docs/appManagement/Retiring.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
stoplight-id: ttmhuovvyy6rs
---


# Retiring the App

Before retiring an app, you must first go through the following steps:
Expand Down
4 changes: 0 additions & 4 deletions articles/Extensibility/docs/appManagement/Sharing.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
stoplight-id: ruuiy7dsn27on
---

# Sharing the App
By default, a newly registered app is private, meaning that only the developer tenant has access to it. However, you can share your app with other tenants even if it hasn't been published yet.

Expand Down
4 changes: 0 additions & 4 deletions articles/Extensibility/docs/appManagement/Updating.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
stoplight-id: b7cdff09ad767
---

# Updating the App

There might be times when you need to make changes to your app. Whether you want to fix bugs, correct flaws, or add new functionality, the changes should eventually reach your registered app instance. That's why RWS Trados supports app versioning.
Expand Down
4 changes: 0 additions & 4 deletions articles/Extensibility/docs/appManagement/Validating.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
stoplight-id: aacd1775aae19
---

# Validating Account Settings

As we have already seen, most apps require some configuration settings in order to serve their purpose. For example, the machine translation apps such as Google and DeepL may need some credentials to communicate with the 3rd party MT provider.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
tags: [Consumer]
stoplight-id: xmvf6rjkuqma6
---


# Automatic Task

Automatic Task apps offer the possibility to add custom functionality within a project's workflow.
Expand Down
4 changes: 0 additions & 4 deletions articles/Extensibility/docs/consumer/Dynamic-Preview-guide.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
stoplight-id: j6yjjz5b5gtv5
---

# Dynamic Preview
Dynamic Preview apps offer the ability to render previews dynamically based on selections the user makes in the preview page.

Expand Down
6 changes: 0 additions & 6 deletions articles/Extensibility/docs/consumer/MT-App-consumer-guide.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
tags: [Consumer]
stoplight-id: aq5ppczlrfiwc
---


# Machine Translation

Machine Translation apps offer the possibility to use external machine translation providers within the Trados platform.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
stoplight-id: fhf8qgiqk5ml3
---

# Add-on to App Migration

If you previously have developed an add-on, you have to migrate it to the app concept. Add-ons have in the descriptor the property `descriptorVersion` with value `1.3` or less. Apps start with `descriptorVersion` `1.4`.
Expand Down
4 changes: 0 additions & 4 deletions articles/Extensibility/docs/development/App-Descriptor.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
stoplight-id: 1j4h4ccwlvxkq
---

# App Descriptor

A descriptor defines what the app does. The very first interaction between Trados and an app is requesting the descriptor.
Expand Down
5 changes: 0 additions & 5 deletions articles/Extensibility/docs/development/App-Versioning.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
stoplight-id: 8qooshkz6t5ps
---


# App Versioning

This article explains how the app versions work and how to use multiple versions of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
tags: [Development]
stoplight-id: 2dlyn1ep2e2p5
---


# Automatic Task

Automatic Task extensions offer the possibility to add custom functionality within a project's workflow.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
tags: [Development]
stoplight-id: y6tealkmfbf36
---


# Machine Translation

Machine Translation apps offer the possibility to use external machine translation providers within the Trados platform.
Expand Down
5 changes: 0 additions & 5 deletions articles/Extensibility/docs/development/Multi-Region.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
stoplight-id: 4x29bwcvq2f84
tags: [Development]
---

# Multi-Region

To fulfill the requirements of our customers, Trados Enterprise allows multi-region deployments of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
tags: [Development]
stoplight-id: i7ib8ruwpxdxr
---


# Preview Provider

## Introduction
Expand Down
4 changes: 0 additions & 4 deletions articles/Extensibility/docs/development/Trados-Cloud-API.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
stoplight-id: ca24im2xg3ra8
---

# Trados Cloud Platform API

Communication to Trados Cloud Platform API is also authenticated and the process is described in the [Trados Cloud Platform API documentation](https://languagecloud.sdl.com/lc/api-docs).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
stoplight-id: gwyrrbtyn4j2i
tags: [Development]
---

# Custom Elements and Locations

The platform supports the addition of various UI elements, including **buttons** (generic, link, and dropdown) and **panels** (generic, sidebar, and tab).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
stoplight-id: f15btr2xmf7u9
tags: [Development]
---

# User Interface App Development Guide

UI extensions offer the possibility to add custom user interface elements and functionality. Custom [buttons and panels can be added to specific places](UI-App-custom-elements-locations.md) within the user interface.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
stoplight-id: 9r7ku59767q11
---


# Verification Provider

## Overview
Expand Down
5 changes: 0 additions & 5 deletions articles/Extensibility/docs/development/Webhooks.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
stoplight-id: vh5fg9b14gm43
---


# Webhooks

Apps can specify a list of webhooks that will be registered automatically when the app is installed on an account. That allows the app to specify a list of webhooks and consume them, allowing for asynchronous scenarios where the app can wait for events instead of polling constantly to check for a particular event or state improving performance both for the app and for Trados.
Expand Down
Loading