Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/andrewsu-patch-1'
Browse files Browse the repository at this point in the history
  • Loading branch information
RichardBruskiewich committed Sep 14, 2023
2 parents 8313fc1 + f653162 commit da34cc1
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/architecture/ara/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ Translator "Autonomous Relay Agents" (ARAs) build build upon the knowledge contr
| [Ranking Agent](https://github.com/NCATSTranslator/Translator-All/wiki/Ranking-Agent) | Ranking Agent ('Aragorn') | [Aragorn Wiki](https://github.com/NCATSTranslator/Translator-All/wiki/ARAGORN) | [ranking-agent/aragorn](https://github.com/ranking-agent/aragorn) |
| [Expander Agent](../../teams/expander-agent) | ARAX | [ARAX Page](arax)<br/>[ARAX Wiki](https://github.com/NCATSTranslator/Translator-All/wiki/ARAX) | [RTXteam/RTX](https://github.com/RTXteam/RTX) |
| (im)Proving Agent | Scalable Precision Medicine<br>Oriented Knowledge Engine ('SPOKE') | [SPOKE Wiki](https://github.com/NCATSTranslator/Translator-All/wiki/imProving-Agent) | [BaranziniLab/PSEV](https://github.com/BaranziniLab/PSEV) |
| Explorer Agent | [BioThings Explorer](https://biothings.io/explorer/) | [BioThings Explorer Wiki](https://github.com/NCATSTranslator/Translator-All/wiki/BioThings-Explorer-(BTE)) | [biothings/biothings_explorer](https://github.com/biothings/biothings_explorer) |
| Explorer Agent | [BioThings Explorer](https://explorer.biothings.io/) | [BioThings Explorer Wiki](https://github.com/NCATSTranslator/Translator-All/wiki/BioThings-Explorer-(BTE)) | [biothings/biothings_explorer](https://github.com/biothings/biothings_explorer) |
| Explanatory Agent | xARA | [xARA Wiki](https://github.com/NCATSTranslator/Translator-All/wiki/Explanatory-Agent) ||
| Unsecret Agent | Unsecret Agent | [Unsecret Wiki](https://github.com/NCATSTranslator/Translator-All/wiki/UnSecret-Agent) | [webyrd/mediKanren](https://github.com/webyrd/mediKanren) |
2 changes: 1 addition & 1 deletion docs/architecture/registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To see a more detailed description of how SmartAPI tracks and monitors these sta

First, a web-based API must be built for the knowledgebase or tool.

1. ✅ Build a REST API with JSON output (use your own preferred structure). Then work with the Service Provider team (see the [_Getting Help_](#getting-help) below) to write and register a SmartAPI file with the extensions needed for [BioThings Explorer (BTE)](https://biothings.io/explorer/) to query your API and process its output. In some cases, you may also work with BTE's team to get BTE to correctly process your API's output. This "wrapping" of your API with BTE will make your API compliant with various Translator standards (TRAPI formats and Biolink-Model semantics), which will make it usable within the Translator ecosystem of tools.
1. ✅ Build a REST API with JSON output (use your own preferred structure). Then work with the Service Provider team (see the [_Getting Help_](#getting-help) below) to write and register a SmartAPI file with the extensions needed for [BioThings Explorer (BTE)](https://explorer.biothings.io/) to query your API and process its output. In some cases, you may also work with BTE's team to get BTE to correctly process your API's output. This "wrapping" of your API with BTE will make your API compliant with various Translator standards (TRAPI formats and Biolink-Model semantics), which will make it usable within the Translator ecosystem of tools.
2. ✅ Design an API compliant with the [Translator Reasoner Application Programming Interface (TRAPI) standard](trapi.md), add the required [SmartAPI (Translator) extensions](#translator-specific-smartapi-extensions) annotations to the resulting OpenAPI 3.0 yaml specification of your API, then [register it in the SmartAPI Registry](#registering-your-translator-api).
3. ✅ Deploy your API into a [specified **`x-maturity`**-tagged server environment](https://github.com/NCATSTranslator/TranslatorArchitecture/blob/master/SmartAPIRegistration.md#environments) and add the endpoint to the servers block of the API.

Expand Down

0 comments on commit da34cc1

Please sign in to comment.