Skip to content

Commit 6066d3c

Browse files
authored
Update openapi.template.yaml
Fix the requestorRef
1 parent 30d587d commit 6066d3c

1 file changed

Lines changed: 26 additions & 26 deletions

File tree

‎openapi/ojp1.0/openapi.template.yaml‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
openapi: 3.0.3
1+
openapi: "3.0.3"
22
info:
3-
title: Swiss OJP 1.0 OpenAPI explorer
4-
version: '1.1'
3+
title: "Swiss OJP 1.0 OpenAPI explorer"
4+
version: "1.1"
55
description: |
66
This swagger introduces the list of provided services the Swiss OJP 1.0 service. The interface follows the CEN standard interface OJP (Open API for distributed Journey Planning).
77
Keys for the API can be issued in our API manager https://api-manager.opentransportdata.swiss/.
88
9-
You can alter the different examples provided. Some parts are commented out. You need to make them valid again, in order to get a useful response (e.g. set it to the current date or time)
9+
You can alter the different examples provided. Some parts are commented out. You need to make them valid again, in order to get a useful response (e.g. set it to the current date or time).
1010
1111
We offer currently tests for the following services:
1212
- OJPLocationRequest: LIR
1313
- OJPStopEventRequest: SER
1414
- OJPTripRequest: TR
1515
- OJPTripInfoRequest: TIR
1616
externalDocs:
17-
description: OJP documentation
17+
description: "OJP documentation"
1818
url: https://transmodel-cen.eu/index.php/ojp/
1919
servers:
2020
- url: https://api.opentransportdata.swiss
@@ -29,9 +29,9 @@ security:
2929
paths:
3030
/ojp2020:
3131
post:
32-
summary: OJP 1.0 acccess
33-
operationId: OJP1.0
34-
description: OJP is a traditional API, where the operation definitions is done in body of the post request
32+
summary: "OJP 1.0 acccess"
33+
operationId: "OJP1.0"
34+
description: "OJP is a traditional API, where the operation definitions is done in body of the post request"
3535
requestBody:
3636
required: true
3737
content:
@@ -43,8 +43,8 @@ paths:
4343
wrapped: true
4444
examples:
4545
exampleLIR:
46-
summary: LIR - Simple
47-
description: Simple OJPLocationInformationtRequest for Bern
46+
summary: "LIR - Simple"
47+
description: "Simple OJPLocationInformationtRequest for Bern"
4848
value: |
4949
<?xml version="1.0" encoding="UTF-8"?>
5050
<OJP xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.siri.org.uk/siri" version="1.0" xmlns:ojp="http://www.vdv.de/ojp" xsi:schemaLocation="http://www.siri.org.uk/siri ../ojp-xsd-v1.0/OJP.xsd">
@@ -67,8 +67,8 @@ paths:
6767
</OJPRequest>
6868
</OJP>
6969
exampleSER:
70-
summary: SER - Simple
71-
description: Simple OJPStopEventRequest for Bern
70+
summary: "SER - Simple"
71+
description: "Simple OJPStopEventRequest for Bern"
7272
value: |
7373
<?xml version="1.0" encoding="UTF-8"?>
7474
<OJP xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.siri.org.uk/siri" version="1.0" xmlns:ojp="http://www.vdv.de/ojp" xsi:schemaLocation="http://www.siri.org.uk/siri ../ojp-xsd-v1.0/OJP.xsd">
@@ -103,15 +103,15 @@ paths:
103103
</OJPRequest>
104104
</OJP>
105105
exampleTR:
106-
summary: TR - Simple
107-
description: Simple OJPTripRequest
106+
summary: "TR - Simple"
107+
description: "Simple OJPTripRequest"
108108
value: |
109109
<?xml version="1.0" encoding="UTF-8"?>
110110
<OJP xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.siri.org.uk/siri" version="1.0" xmlns:ojp="http://www.vdv.de/ojp" xsi:schemaLocation="http://www.siri.org.uk/siri ../ojp-xsd-v1.0/OJP.xsd">
111111
<OJPRequest>
112112
<ServiceRequest>
113113
<RequestTimestamp>2025-09-09T14:45:04.318Z</RequestTimestamp>
114-
<RequestorRef>MENTZRegTest</RequestorRef>
114+
<RequestorRef>API-Explorer</RequestorRef>
115115
<ojp:OJPTripRequest>
116116
<RequestTimestamp>2025-09-09T14:45:04.318Z</RequestTimestamp>
117117
<MessageIdentifier>TR-1a1</MessageIdentifier>
@@ -140,15 +140,15 @@ paths:
140140
</OJPRequest>
141141
</OJP>
142142
exampleTIR:
143-
summary: TIR - Simple
144-
description: Simple OJPTripInformationRequest
143+
summary: "TIR - Simple"
144+
description: "Simple OJPTripInformationRequest"
145145
value: |
146146
<?xml version="1.0" encoding="UTF-8"?>
147147
<OJP xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.siri.org.uk/siri" version="1.0" xmlns:ojp="http://www.vdv.de/ojp" xsi:schemaLocation="http://www.siri.org.uk/siri ../ojp-xsd-v1.0/OJP.xsd">
148148
<OJPRequest>
149149
<ServiceRequest>
150150
<RequestTimestamp>2025-09-09T14:13:22.070Z</RequestTimestamp>
151-
<RequestorRef>MENTZRegTest</RequestorRef>
151+
<RequestorRef>API-Explorer</RequestorRef>
152152
<ojp:OJPTripInfoRequest>
153153
<RequestTimestamp>2025-09-09T14:13:22.070Z</RequestTimestamp>
154154
<MessageIdentifier>TIR-1a</MessageIdentifier>
@@ -161,7 +161,7 @@ paths:
161161
</OJP>
162162
responses:
163163
'401':
164-
description: Unauthorized
164+
description: "Unauthorized"
165165
content:
166166
application/json:
167167
schema:
@@ -173,12 +173,12 @@ paths:
173173
- error
174174
examples:
175175
exampleAX:
176-
summary: Wrong or no key provided
177-
description: Get a correct key and apply it correctly.
176+
summary: "Wrong or no key provided"
177+
description: "Get a correct key and apply it correctly."
178178
value:
179-
error: Authorization field missing
179+
error: "Authorization field missing"
180180
'429':
181-
description: Rate limit exceeded
181+
description: "Rate limit exceeded"
182182
content:
183183
application/json:
184184
schema:
@@ -190,7 +190,7 @@ paths:
190190
- error
191191
examples:
192192
exampleAY:
193-
summary: Too many requests
194-
description: Wait some time till your key allows further requests or get a API key with a higher rate limit.
193+
summary: "Too many requests"
194+
description: "Wait some time till your key allows further requests or get a API key with a higher rate limit."
195195
value:
196-
error: Rate limit exceeded
196+
error: "Rate limit exceeded"

0 commit comments

Comments
 (0)