entity-v1/openAPI3-documentation.yaml at master · Sphere/entity-v1 · GitHub

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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
openapi: 3.0.3
info:
  title: Entity Competency API
  description: API documentation for managing and retrieving FRAC entities such as Competency, Role, and Position.
  version: 1.0.0

servers:
  - url: https://your-hostname.com

paths:
  /entityCompetency/getEntityById/{id}:
    post:
      summary: Get entity by ID
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
          description: Unique identifier of the entity
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                filter:
                  type: object
                  properties:
                    isDetail:
                      type: boolean
                  required: [isDetail]
              required: [filter]
      responses:
        '200':
          description: Entity retrieved successfully
          content:
            application/json:
              schema:
                type: object
                example:
                  type: "Competency"
                  name: "Injectables, IV and fluid therapy"
                  description: "Administer injectables, insert IV Line and provide fluid therapy"
                  additionalProperties:
                    Code: "ME73"
                    subject: "Medical Surgical Nursing"
                    competencyLevelDescription: "[{...}]"

  /addUpdateEntity:
    post:
      summary: Add or update an entity
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                name:
                  type: string
                description:
                  type: string
                id:
                  type: integer
                additionalProperties:
                  type: object
              required: [type, name, description]
      responses:
        '200':
          description: Entity added or updated successfully
          content:
            application/json:
              schema:
                type: object
                example:
                  message: "Entity updated successfully"
                  status: "success"

  /getAllEntity:
    post:
      summary: Get all entities by filter
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                search:
                  type: object
                  properties:
                    type:
                      type: string
              required: [search]
      responses:
        '200':
          description: Entities retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object