api.template 2.12 KB
Newer Older
jcorvi's avatar
jcorvi committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
openapi: 3.0.2
info:
  title: Pretox TM
  termsOfService: http://etransafe.eu
  description: >
    A preclinical text mining tool for detecting treatment-related findings.
  contact:
    name: BSC
    url: https://www.bsc.es/
    email: javier.corvi@bsc.es
  license:
    name: eTRANSAFE Consortium License 1.0
    url: https://etransafe.eu
  version: {APP_VERSION}
  x-meta:
    serviceType: frontend
    uuid: {UUID}
    provider: BSC
    created: 2022-01-31
    released: {RELEASE_DATE}
    lastChanged: {RELEASE_DATE}
    software: 
      - name: Angular
        version: 11
        description: Angular framework
        provider: Acme Corporation
        license: 
          name: Angular MIT-License
          url: https://angular.io/license
servers:
- url: /manage/v1
  description: Base URL of the API
paths:
  /api:
    get:
      summary: Returns this API definition
      description: Reports this API definition.
      responses:
        200:
          description: YAML specification of this API
          content:
            text/yaml:
              schema:
                type: object
  /ready:
    get:
      summary: Returns the online status of the service
      description: Reports the online status (readiness) of the service.
      responses:
        200:
          description: Service is ready.
          content:
            text/plain:
              schema:
                type: string
                example: Service is ready.
  /alive:
    get:
      summary: Returns the health status of the service
      description: Reports the health status (leaviness) of the service.
      responses:
        200:
          description: Service is alive.
          content:
            text/plain:
              schema:
                type: string
                example: Service is alive and healthy.
  /../../..:
    get:
      summary: UI of the service
      description: Redirects to the UI of the service, which would be <host>/basePath/ then.
      responses:
        200:
          description: Service UI.
          content:
            text/html:
              schema:
                type: string
                example: Service UI.