From 247e08c0ced7e4bf31cc7295b7982424541d4b96 Mon Sep 17 00:00:00 2001 From: Connor Boyle Date: Mon, 28 Feb 2022 13:54:26 -0800 Subject: [PATCH 1/2] Add ToolDependency Object, Change ToolDependencies to Use it --- .../components/schemas/ToolDependencies.yaml | 2 +- .../components/schemas/ToolDependency.yaml | 23 +++++++++++++++++++ 2 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 openapi/commons/components/schemas/ToolDependency.yaml diff --git a/openapi/commons/components/schemas/ToolDependencies.yaml b/openapi/commons/components/schemas/ToolDependencies.yaml index c16f5676..c3d9ad6f 100644 --- a/openapi/commons/components/schemas/ToolDependencies.yaml +++ b/openapi/commons/components/schemas/ToolDependencies.yaml @@ -5,6 +5,6 @@ properties: description: A list of tools type: array items: - $ref: Tool.yaml + $ref: ToolDependency.yaml required: - tools \ No newline at end of file diff --git a/openapi/commons/components/schemas/ToolDependency.yaml b/openapi/commons/components/schemas/ToolDependency.yaml new file mode 100644 index 00000000..edb2dd8b --- /dev/null +++ b/openapi/commons/components/schemas/ToolDependency.yaml @@ -0,0 +1,23 @@ +type: object +description: Information about an NLP tool within the context of its use +properties: + tool: + $ref: Tool.yaml + functionalType: + $ref: ../parameters/ToolType.yaml +required: + - tool + - functionalType +example: + tool: + name: awesome-nlp-tool + version: 1.0.6 + license: apache-2.0 + repository: github:awesome-org/awesome-nlp-tool + description: An awesome NLP Tool that takes as input X and outputs Y. + author: Awesome Team + authorEmail: author@example.com + url: https://example.com + type: nlpsandbox:phi-annotator + apiVersion: 1.2.0 + functionalType: nlpsandbox:date-annotator From 1907a043445cbb85abe6abbf73fe7d87d9148600 Mon Sep 17 00:00:00 2001 From: Connor Boyle Date: Mon, 28 Feb 2022 13:55:45 -0800 Subject: [PATCH 2/2] `tools` -> `toolDependencies` --- openapi/commons/components/schemas/ToolDependencies.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/openapi/commons/components/schemas/ToolDependencies.yaml b/openapi/commons/components/schemas/ToolDependencies.yaml index c3d9ad6f..0f0f0f21 100644 --- a/openapi/commons/components/schemas/ToolDependencies.yaml +++ b/openapi/commons/components/schemas/ToolDependencies.yaml @@ -1,10 +1,10 @@ type: object description: A list of tool dependencies properties: - tools: - description: A list of tools + toolDependencies: + description: A list of tool dependencies type: array items: $ref: ToolDependency.yaml required: - - tools \ No newline at end of file + - toolDependencies \ No newline at end of file