Skip to content

Commit

Permalink
#372 Continuous, on-demand spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
jspetrak committed Jan 17, 2025
1 parent 3db1775 commit 285113d
Showing 1 changed file with 45 additions and 45 deletions.
90 changes: 45 additions & 45 deletions specification/v4.0/OSDM-online-api-v4.0.0-draft.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2225,11 +2225,11 @@ paths:
'default':
$ref: '#/components/responses/DefaultErrorResponse'

/fulfillments/{fulfillmentId}/continuous-service-usage/{continousServiceUsageId}:
/fulfillments/{fulfillmentId}/continuous-service-usage/{continuousServiceUsageId}:
get:
tags:
- Fulfillments
- On Demand Services
- On-Demand Services
summary: return the continuous service usage including latest updates
parameters:
- $ref: '#/components/parameters/requestor'
Expand All @@ -2244,21 +2244,21 @@ paths:
required: true
schema:
type: string
- name: continousServiceUsageId
- name: continuousServiceUsageId
in: path
description: |
id of the continous service usage to get.
id of the continuous service usage to get.
required: true
schema:
type: string
responses:
'200':
description: |
continous service usage found
continuous service usage found
content:
application/json:
schema:
$ref: '#/components/schemas/ContinousServiceUsage'
$ref: '#/components/schemas/ContinuousServiceUsage'
headers:
Content-Language:
schema:
Expand Down Expand Up @@ -2287,12 +2287,12 @@ paths:
patch:
tags:
- Fulfillments
- On Demand Services
- On-Demand Services
summary:
start or end the usage of a continuous service of an demand vehicle
description: |
Changes the fulfillment to status AVAILABLE. In the case of multi-journey product, one of the fulfillment is now 'activated' and can be used to travel.
operationId: patchContinousServiceUsageId
operationId: patchContinuousServiceUsageId
parameters:
- $ref: '#/components/parameters/requestor'
- $ref: '#/components/parameters/acceptLanguage'
Expand All @@ -2305,10 +2305,10 @@ paths:
required: true
schema:
type: string
- name: continousServiceUsageId
- name: continuousServiceUsageId
in: path
description: |
id of the continous service usage to get.
id of the continuous service usage to get.
required: true
schema:
type: string
Expand All @@ -2317,15 +2317,15 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/ContinousServiceUsagePatchRequest'
$ref: '#/components/schemas/ContinuousServiceUsagePatchRequest'
responses:
'200':
description: |
fulfillment patched
content:
application/json:
schema:
$ref: '#/components/schemas/ContinousServiceUsage'
$ref: '#/components/schemas/ContinuousServiceUsage'
headers:
Content-Language:
schema:
Expand Down Expand Up @@ -4336,11 +4336,11 @@ paths:
get:
tags:
- Availabilities
- On Demand Services
summary: Get availabilities of an on demand service.
- On-Demand Services
summary: Get availabilities of an on-demand service.
description: |
Get availabilities of an on demand services.
operationId: getAvailabilitiesContinousServices
Get availabilities of an on-demand services.
operationId: getAvailabilitiesContinuousServices
parameters:
- $ref: '#/components/parameters/requestor'
- $ref: '#/components/parameters/traceParent'
Expand Down Expand Up @@ -4374,7 +4374,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/ContinousServicesAvailabilityResponse'
$ref: '#/components/schemas/ContinuousServicesAvailabilityResponse'
headers:
Content-Language:
schema:
Expand Down Expand Up @@ -6044,10 +6044,10 @@ components:
type: array
items:
$ref: '#/components/schemas/Ancillary'
continousServices:
continuousServices:
type: array
items:
$ref: '#/components/schemas/ContinousServiceBookingPart'
$ref: '#/components/schemas/ContinuousServiceBookingPart'
fees:
type: array
items:
Expand Down Expand Up @@ -6438,7 +6438,7 @@ components:
- 'ADMISSION'
- 'RESERVATION'
- 'ANCILLARY'
- 'CONTINOUS_SERVICE'
- 'CONTINUOUS_SERVICE'

BookingPatchRequest:
type: object
Expand Down Expand Up @@ -7624,7 +7624,7 @@ components:
destinationText:
type: string

ContinousServiceBookingPart:
ContinuousServiceBookingPart:
description: |
A booking part for a continuous on-demand service.
allOf:
Expand All @@ -7647,7 +7647,7 @@ components:
type: string
maxLength: 1024

ContinousServiceOfferPart:
ContinuousServiceOfferPart:
description: |
An offer part for a continuous on-demand service.
allOf:
Expand All @@ -7666,7 +7666,7 @@ components:
minItems: 1
maxItems: 500

ContinousServiceUsage:
ContinuousServiceUsage:
description: Usage of a continuos service vehicle
type: object
additionalProperties: false
Expand All @@ -7680,7 +7680,7 @@ components:
type: string
maxLength: 1024
status:
$ref: '#/components/schemas/ContinousServiceUsageStatus'
$ref: '#/components/schemas/ContinuousServiceUsageStatus'
geoPosition:
$ref: '#/components/schemas/GeoPosition'
startUsageDescription:
Expand Down Expand Up @@ -7714,7 +7714,7 @@ components:
type: string
format: date-time

ContinousServiceUsageStatus:
ContinuousServiceUsageStatus:
description: status of the usage of a vehicle
type: string
x-extensible-enum:
Expand All @@ -7728,7 +7728,7 @@ components:
the traveler did not end the usage but the maximal length of the
usage was reached.

ContinousServiceUsagePatchRequest:
ContinuousServiceUsagePatchRequest:
description: Usage of a continuos service vehicle
type: object
additionalProperties: false
Expand All @@ -7740,7 +7740,7 @@ components:
type: string
maxLength: 1024
status:
$ref: '#/components/schemas/ContinousServiceUsageStatus'
$ref: '#/components/schemas/ContinuousServiceUsageStatus'
parkingImage:
description: |
base64 encoded binary of the jpg image of the parked vehicle when ending the usage.
Expand All @@ -7752,7 +7752,7 @@ components:
tip:
$ref: '#/components/schemas/Tip'

ContinousServiceVehicleSelection:
ContinuousServiceVehicleSelection:
type: object
additionalProperties: false
required:
Expand All @@ -7764,17 +7764,17 @@ components:
type: string
maxLength: 1024
vehicleType:
$ref: '#/components/schemas/ContinousServiceVehicleType'
$ref: '#/components/schemas/ContinuousServiceVehicleType'

ContinousServicesAvailabilityResponse:
ContinuousServicesAvailabilityResponse:
type: object
additionalProperties: false
required:
- pickUpPlaces
properties:
pickUpPlaces:
description: |
list of pick-up places for on demand vehicles. The list might include more or other pick up places than mentioned originally in the trip specification.
list of pick-up places for on-demand vehicles. The list might include more or other pick up places than mentioned originally in the trip specification.
type: array
items:
$ref: '#/components/schemas/ContinuousServicePickUpPlace'
Expand Down Expand Up @@ -7804,7 +7804,7 @@ components:
examples:
- 'Taxi Stand Main Station East Exit'
accessDescription:
description: 'description on how to access the on demand vehicle'
description: 'description on how to access the on-demand vehicle'
type: string
maxLength: 32768
examples:
Expand All @@ -7826,7 +7826,7 @@ components:
- PT30M
processIndication:
description:
Machine readable indications on how the on demand process should be
Machine readable indications on how the on-demand process should be
handled.
type: array
items:
Expand All @@ -7844,8 +7844,8 @@ components:

ContinuousServiceProcessIndication:
description: |
Process indications for on demand services
[On Demand Vehicle Types](https://osdm.io/spec/catalog-of-code-lists/#OnDemandVehicleProcesses)
Process indications for on-demand services
[On-Demand Vehicle Types](https://osdm.io/spec/catalog-of-code-lists/#OnDemandVehicleProcesses)
type: string
x-extensible-enum:
- 'PRE_ALLOCATION_REQUIRED'
Expand Down Expand Up @@ -7881,13 +7881,13 @@ components:
examples:
- 'Scooter up to 120 kg traveler weight'
vehicleType:
$ref: '#/components/schemas/ContinousServiceVehicleType'
$ref: '#/components/schemas/ContinuousServiceVehicleType'
availableVehicles:
description: number of available vehicles
type: integer
format: int32

ContinousServiceVehicleType:
ContinuousServiceVehicleType:
description: |
[Vehicle types from code list of on-demand vehicle types](https://osdm.io/spec/catalog-of-code-lists/#OnDemandVehicleTypes)
type: string
Expand Down Expand Up @@ -9005,8 +9005,8 @@ components:
Indicates whether the fulfillment has all documents or parts generated (if any needed) or they are still pending generation.
tripCoverage:
$ref: '#/components/schemas/TripCoverage'
continousServiceUsage:
$ref: '#/components/schemas/ContinousServiceUsage'
continuousServiceUsage:
$ref: '#/components/schemas/ContinuousServiceUsage'
_links:
description: |
Java Property Name: 'links'
Expand Down Expand Up @@ -9051,8 +9051,8 @@ components:
- 'null'
items:
type: string
continousServiceVehicleSelection:
$ref: '#/components/schemas/ContinousServiceVehileSelection'
continuousServiceVehicleSelection:
$ref: '#/components/schemas/ContinuousServiceVehileSelection'

FulfillmentCollectionResponse:
type: object
Expand Down Expand Up @@ -10359,10 +10359,10 @@ components:
type: array
items:
$ref: '#/components/schemas/AncillaryOfferPart'
continousServiceOfferParts:
continuousServiceOfferParts:
type: array
items:
$ref: '#/components/schemas/ContinousServiceOfferPart'
$ref: '#/components/schemas/ContinuousServiceOfferPart'
fees:
type: array
items:
Expand Down Expand Up @@ -10522,7 +10522,7 @@ components:
- 'FARE_ADMISSION'
- 'FARE_RESERVATION'
- 'FARE_ANCILLARY'
- 'CONTINOUS_SERVICE'
- 'CONTINUOUS_SERVICE'
- 'ALL'

OfferSearchCriteria:
Expand Down Expand Up @@ -13462,7 +13462,7 @@ components:
minimum: 0
requestStop:
description: |
The vehicle journey calls at this stop only on demand.
The vehicle journey calls at this stop only on-demand.
type:
- 'boolean'
- 'null'
Expand Down

0 comments on commit 285113d

Please sign in to comment.