hector_api/swagger.yml at main · HectorPage/hector_api · 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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
openapi: 3.0.0
info:
  title: "EU MRV Shipping Emissions API"
  description: "EU MRV Shipping Emissions API"
  version: "1.0.0"

servers:
  - url: "/api"

components:
  schemas:
    Ship:
      type: "object"
      required:
        - imo_number
        - name
        - reporting_year
      properties:
        pk_ships:
          type: integer
        imo_number:
          type: integer
        name:
          type: string
        ship_type:
          type: string
        reporting_period:
          type: integer
        technical_efficiency:
          type: string
        port_of_registry:
          type: string
        home_port:
          type: string
        ice_class:
          type: string
        doc_issue_date:
          type: string
        doc_expiry_date:
          type: string
        verifier_number:
          type: integer
        verifier_name:
          type: string
        verifier_nab:
          type: string
        verifier_address:
          type: string
        verifier_city:
          type: string
        verifier_accreditation_number:
          type: string
        verifier_country:
          type: string
        monitoring_method_a:
          type: string
        monitoring_method_b:
          type: string
        monitoring_method_c:
          type: string
        monitoring_method_d:
          type: string
        total_fuel_consumption:
          type: number
        fuel_consumption_on_laden:
          type: number
        total_co2_emissions:
          type: number
        co2_emissions_between_ms_ports:
          type: number
        co2_emissions_departing_ms_ports:
          type: number
        co2_emissions_arriving_ms_ports:
          type: number
        co2_emissions_berthed_ms_ports:
          type: number
        co2_emissions_passenger:
          type: number
        co2_emissions_freight:
          type: number
        co2_emissions_on_laden:
          type: number
        annual_total_time_at_sea:
          type: number
        annual_avg_fuel_consumption_per_distance:
          type: number
        annual_avg_fuel_consumption_per_work_mass:
          type: number
        annual_avg_fuel_consumption_per_work_volume:
          type: number
        annual_avg_fuel_consumption_per_work_dwt:
          type: number
        annual_avg_fuel_consumption_per_work_pax:
          type: number
        annual_avg_fuel_consumption_per_work_freight:
          type: number
        annual_avg_co2_emissions_per_distance:
          type: number
        annual_avg_co2_emissions_per_work_mass:
          type: number
        annual_avg_co2_emissions_per_work_volume:
          type: number
        annual_avg_co2_emissions_per_work_dwt:
          type: number
        annual_avg_co2_emissions_per_work_pax:
          type: number
        annual_avg_co2_emissions_per_work_freight:
          type: number
        through_ice:
          type: number
        total_time_at_sea:
          type: number
        total_time_at_sea_ice:
          type: number
        fuel_consumption_per_distance_laden:
          type: number
        fuel_consumption_per_work_mass_laden:
          type: number
        fuel_consumption_per_work_volume_laden:
          type: number
        fuel_consumption_per_work_dwt_laden:
          type: number
        fuel_consumption_per_work_pax_laden:
          type: number
        fuel_consumption_per_work_freight_laden:
          type: number
        co2_emissions_per_distance_laden:
          type: number
        co2_emissions_per_work_mass_laden:
          type: number
        co2_emissions_per_work_volume_laden:
          type: number
        co2_emissions_per_work_dwt_laden:
          type: number
        co2_emissions_per_work_pax_laden:
          type: number
        co2_emissions_per_work_freight_laden:
          type: number
        additional_info:
          type: string
        average_cargo_density:
          type: string
  parameters:
    name:
      name: "name"
      description: "Name of the ship"
      in: path
      required: True
      schema:
        type: "string"
    imo_number:
      name: "imo_number"
      description: "IMO number of the ship"
      in: path
      required: True
      schema:
        type: "string"
    reporting_period:
      name: "reporting_period"
      description: "Reporting year of the ship"
      in: path
      required: True
      schema:
        type: "integer"

paths:
  /ships:
    get:
      operationId: "ships.read_filtered"
      tags:
        - "Ships"
      parameters:
        - in: query
          name: name
          schema:
            type: string
          description: Limits returned data to ships with this name
        - in: query
          name: imo
          schema:
            type: string
          description: Limits returned data to ships with this IMO number
        - in: query
          name: year
          schema:
            type: integer
          description: Limits returned data to reporting year specified
      summary: "Read the list of ships, optionally filtered by combinations of Name/IMO Number/Reporting Period"
      responses:
        "200":
          description: "Successfully read ships list"