Skip to content

Commit 36b3a7f

Browse files
Cgapi status check (#200)
* Add status check endpoint for concept graphs api * Improved response * Add default return to pipeline manager status * Bump up version * Reformat schema file --------- Co-authored-by: Christoph Beger <ChristophB@users.noreply.github.com>
1 parent 790b977 commit 36b3a7f

2 files changed

Lines changed: 28 additions & 2 deletions

File tree

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<artifactId>top-api</artifactId>
66
<packaging>jar</packaging>
77
<name>TOP API</name>
8-
<version>0.14.0</version>
8+
<version>0.14.1</version>
99
<description>REST API of the TOP framework</description>
1010
<properties>
1111
<java.version>21</java.version>

schemas/top-api.yml

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.0
22
info:
33
title: TOP API
4-
version: 0.14.0
4+
version: 0.14.1
55
description: |-
66
API to manage phenotypes, repositories, ontologies, external terminologies and organisations and to execute phenotypic queries.
77
@@ -561,6 +561,19 @@ paths:
561561
$ref: '#/components/responses/UnexpectedError'
562562
tags:
563563
- conceptPipeline
564+
/concept_pipeline/status:
565+
get:
566+
operationId: getConceptPipelineManagerStatus
567+
summary: Returns the status of the concept pipeline manager and whether it's enabled/active
568+
responses:
569+
'200':
570+
$ref: '#/components/responses/ConceptGraphManagerResponse'
571+
'404':
572+
$ref: '#/components/responses/ConceptGraphManagerResponse'
573+
default:
574+
$ref: '#/components/responses/UnexpectedError'
575+
tags:
576+
- conceptPipeline
564577
'/concept_pipeline/{pipelineId}':
565578
get:
566579
operationId: getConceptGraphPipelineById
@@ -2651,6 +2664,13 @@ components:
26512664
type: array
26522665
items:
26532666
type: integer
2667+
ConceptGraphManagerStatus:
2668+
type: object
2669+
properties:
2670+
status:
2671+
type: boolean
2672+
enabled:
2673+
type: boolean
26542674
ConceptGraphPipeline:
26552675
type: object
26562676
properties:
@@ -3707,6 +3727,12 @@ components:
37073727
- encounterId
37083728
- passed
37093729
responses:
3730+
ConceptGraphManagerResponse:
3731+
description: Whether the manager is active and/or enabled
3732+
content:
3733+
application/json:
3734+
schema:
3735+
$ref: '#/components/schemas/ConceptGraphManagerStatus'
37103736
NotFound:
37113737
description: The specified resource was not found.
37123738
content:

0 commit comments

Comments
 (0)