ojp-shared.yml

openapi: 3.0.3
info:
  title: Empty API
  version: 1.0.0
paths: {}
components:
  schemas:
    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__PersonalModesEnumeration
    PersonalModesEnumeration:
      type: string
      enum: [ foot, bicycle, car, motorcycle, truck, scooter, other ]
      xml:
        name: PersonalModes

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__PersonalModesOfOperationEnumeration
    PersonalModesOfOperationEnumeration:
      type: string
      enum: [ self, own, otherOwned, privateLift, lease ]
      xml:
        name: PersonalModesOfOperation

    # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__VehicleModesOfTransportEnumeration
    VehicleModesOfTransportEnum:
      type: string
      enum: [
        air, 
        bus, coach, trolleyBus,
        metro, rail, tram,
        water, ferry,
        cableway, funicular, lift, telecabin,
        other, unknown,
      ]

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__UseRealtimeDataEnumeration
    UseRealtimeDataEnum:
      type: string
      enum: [full, explanatory, none]

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__PlaceTypeEnumeration
    PlaceTypeEnum:
      type: string
      enum: [stop, address, poi, location, topographicPlace]

    # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__SituationSourceTypeEnumeration
    SituationSourceTypeEnum:
      type: string
      enum: [
        directReport, 
        email, phone, fax, 
        post, feed, radio, tv, 
        web, pager, text, 
        other, 
      ]

    # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__PerspectiveEnumeration
    PerspectiveEnum:
      type: string
      enum: [general, stopPoint, vehicleJourney]

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__TransferTypeEnumeration
    TransferTypeEnum:
      type: string
      enum: [walk, remainInVehicle, changeWithinVehicle, guaranteedConnection]
      xml:
        name: TransferType
    
    # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__FareClassEnumeration
    FareClassEnum:
      type: string
      enum: [unknown, firstClass, secondClass]
      xml:
        name: FareClass

    # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__OccupancyEnumeration
    OccupancyLevelEnum:
      type: string
      enum: [unknown, empty, manySeatsAvailable, fewSeatsAvailable, standingRoomOnly]
      xml:
        name: FareClass

    # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__RailSubmodesOfTransportEnumeration
    #     highSpeedRail                       - IC
    #     international                       - ICE, TGV, EC, RJX, NJ, EN
    #     interregionalRail                   - IR, IRN, IRE
    #     railShuttle                         - ATZ
    #     local                               - S, SN, RB, RE, PE
    #     vehicleTunnelTransportRailService   - used by ATZ
    RailSubmodeEnum:
      type: string 
      enum: [international, highSpeedRail, interregionalRail, railShuttle, local, vehicleTunnelTransportRailService]
      xml:
        name: RailSubmode
        namespace: "http://www.siri.org.uk/siri"
        prefix: siri

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__OptimisationMethodEnumeration
    OptimisationMethodEnum:
      type: string
      enum: [fastest, minChanges, leastWalking, leastCost, leastDistance, earliestArrival, latestDeparture, earliestArrivalAndLatestDeparture, minNonLevelEntrances, minStairs, bestForVisualImpairment, bestForAuditoryImpairment, environmentalSafety, extraSafe, extraReliable, scenic, quietTravel]

    InternationalText:
      type: object
      xml:
        name: InternationalText
      required:
        - text
      properties:
        text:
          type: string
          xml:
            name: Text
    
    GeoPosition:
      type: object
      xml:
        name: GeoPosition
      required:
        - longitude
        - latitude
      properties:
        longitude:
          type: number
          xml:
            name: Longitude
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        latitude:
          type: number
          xml:
            name: Latitude
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__PlaceRefStructure
    PlaceRef:
      type: object
      required:
        - name
      properties:
        stopPointRef:
          type: string
          xml:
            name: StopPointRef
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        stopPlaceRef:
          type: string
          xml:
            name: StopPlaceRef
        geoPosition:
          $ref: '#/components/schemas/GeoPosition'
          xml:
            name: GeoPosition
        name:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: Name
    
    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__ItModesStructure
    ItModesStructure:
      type: object
      required:
        - personalMode
        - personalModeOfOperation
      xml:
        name: ItModes
      properties:
        personalMode:
          $ref: '#/components/schemas/PersonalModesEnumeration'
          xml:
            name: PersonalMode
        personalModeOfOperation:
          type: array
          xml:
            name: PersonalModeOfOperation
          items:
            $ref: '#/components/schemas/PersonalModesOfOperationEnumeration'
    
    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__IndividualTransportOptionStructure
    IndividualTransportOptionStructure:
      type: object
      required:
        - itModeAndModeOfOperation
      xml:
        name: IndividualTransportOption
      properties:
        itModeAndModeOfOperation:
          $ref: '#/components/schemas/ItModesStructure'
          xml:
            name: ItModeAndModeOfOperation
        maxDistance:
          type: number
          xml:
            name: MaxDistance
        maxDuration:
          type: string
          xml:
            name: MaxDuration
        minDistance:
          type: number
          xml:
            name: MinDistance
        minDuration:
          type: string
          xml:
            name: MinDuration
        speed:
          type: number
          xml:
            name: Speed

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__PlaceContextStructure
    PlaceContext:
      type: object
      xml:
        name: PlaceContext
      required:
        - placeRef
        - individualTransportOption
      properties:
        placeRef:
          $ref: '#/components/schemas/PlaceRef'
          xml:
            name: PlaceRef
        depArrTime:
          type: string
          xml:
            name: DepArrTime
        individualTransportOption:
          type: array
          xml:
            name: IndividualTransportOption
          items:
            $ref: "#/components/schemas/IndividualTransportOptionStructure"

    ServiceRequestContext:
      type: object
      xml:
        name: ServiceRequestContext
        namespace: "http://www.siri.org.uk/siri"
        prefix: siri
      properties:
        language:
          type: string
          xml:
            name: Language
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__OsmTagStructure
    OsmTagStructure:
      type: object
      required:
        - tag
        - value
      properties:
        tag:
          type: string
          xml:
            name: Tag
        value:
          type: string
          xml:
            name: Value
      xml:
        name: OsmTag

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__PointOfInterestCategoryStructure
    PointOfInterestCategoryStructure:
      type: object
      xml:
        name: PointOfInterestCategory
      required:
        - osmTag
        - pointOfInterestClassification
      properties:
        osmTag:
          type: array
          xml:
            name: OsmTag
          items:
            $ref: "#/components/schemas/OsmTagStructure"
        pointOfInterestClassification:
          type: array
          xml:
            name: PointOfInterestClassification
          items:
            type: string
            xml:
              name: PointOfInterestClassification

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__StopPointStructure
    StopPoint:
      type: object
      xml:
        name: StopPoint
      required:
        - stopPointRef
        - stopPointName
      properties:
        stopPointRef:
          type: string
          xml:
            name: StopPointRef
        stopPointName:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: StopPointName
        parentRef:
          type: string
          xml: 
            name: ParentRef
        plannedQuay:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: PlannedQuay
        estimatedQuay:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: EstimatedQuay

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__StopPlaceStructure
    StopPlace:
      type: object
      xml:
        name: StopPoint
      required:
        - stopPlaceRef
        - stopPlaceName
      properties:
        stopPlaceRef:
          type: string
          xml:
            name: StopPlaceRef
        stopPlaceName:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: StopPlaceName

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__TopographicPlaceStructure
    TopographicPlace:
      type: object
      xml:
        name: StopPoint
      required:
        - topographicPlaceCode
        - topographicPlaceName
      properties:
        topographicPlaceCode:
          type: string
          xml:
            name: TopographicPlaceCode
        topographicPlaceName:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: TopographicPlaceName

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__CategoryKeyValueType
    CategoryKeyValueType:
      type: object
      required:
        - key
        - value
      xml:
        name: CategoryKeyValue
      properties:
        key:
          type: string
          xml:
            name: Key
        value:
          type: string
          xml:
            name: Value

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__PointOfInterestStructure
    PointOfInterest:
      type: object
      xml:
        name: PointOfInterest
      required:
        - publicCode
        - name
        - pointOfInterestCategory
      properties:
        publicCode:
          type: string
          xml:
            name: PublicCode
        name:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: Name
        pointOfInterestCategory:
          type: array
          xml:
            name: PointOfInterestCategory
          items:
            $ref: "#/components/schemas/PointOfInterestCategoryStructure"
        privateCode:
          type: object
          required:
            - system
            - value
          xml:
            name: PrivateCode
          properties:
            system:
              type: string
              xml:
                name: System
            value:
              type: string
              xml:
                name: Value
        pOIAdditionalInformation:
          type: object
          required:
            - pOIAdditionalInformation
          xml:
            name: POIAdditionalInformation
          properties:
            pOIAdditionalInformation:
              type: array
              xml:
                name: POIAdditionalInformation
              items:
                $ref: '#/components/schemas/CategoryKeyValueType'
        topographicPlaceRef:
          type: string
          xml:
            name: TopographicPlaceRef

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__AddressStructure
    Address:
      type: object
      xml:
        name: Address
      required:
        - publicCode
        - name
      properties:
        publicCode:
          type: string
          xml:
            name: PublicCode
        name:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: Name
        postCode:
          type: string
          xml:
            name: PostCode
        topographicPlaceName:
          type: string
          xml:
            name: TopographicPlaceName
        topographicPlaceRef:
          type: string
          xml:
            name: TopographicPlaceRef
        street:
          type: string
          xml:
            name: Street
        houseNumber:
          type: string
          xml:
            name: HouseNumber

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__ModeStructure
    ModeStructure:
      type: object
      xml:
        name: Mode
      required:
        - ptMode
      properties:
        ptMode:
          $ref: '#/components/schemas/VehicleModesOfTransportEnum'
          xml:
            name: PtMode
        airSubmode:
          type: string
          xml:
            name: AirSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        busSubmode:
          type: string
          xml:
            name: BusSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        coachSubmode:
          type: string
          xml:
            name: CoachSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        funicularSubmode:
          type: string
          xml:
            name: FunicularSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        metroSubmode:
          type: string
          xml:
            name: MetroSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        tramSubmode:
          type: string
          xml:
            name: TramSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        telecabinSubmode:
          type: string
          xml:
            name: TelecabinSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        railSubmode:
          $ref: "#/components/schemas/RailSubmodeEnum"
          xml:
            name: RailSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        waterSubmode:
          type: string
          xml:
            name: WaterSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        name:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: Name
        shortName:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: ShortName
    
    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__PlaceStructure
    Place:
      type: object
      xml:
        name: Place
      required:
        - name
        - geoPosition
        - mode
        - attribute
      properties:
        stopPoint:
          $ref: '#/components/schemas/StopPoint'
          xml:
            name: StopPoint
        stopPlace:
          $ref: '#/components/schemas/StopPlace'
          xml:
            name: StopPlace
        topographicPlace:
          $ref: '#/components/schemas/TopographicPlace'
          xml:
            name: TopographicPlace
        pointOfInterest:
          $ref: '#/components/schemas/PointOfInterest'
          xml:
            name: PointOfInterest
        address:
          $ref: '#/components/schemas/Address'
          xml:
            name: Address
        name:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: Name
        geoPosition:
          $ref: '#/components/schemas/GeoPosition'
          xml:
            name: GeoPosition
        mode:
          type: array
          xml:
            name: Mode
          items:
            $ref: '#/components/schemas/ModeStructure'
        attribute:
          type: array
          xml:
            name: Attribute
          items:
            $ref: '#/components/schemas/GeneralAttribute'

    # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__TextualContentStructure
    TextualContentStructure:
      type: object
      xml:
        name: TextualContent
        namespace: "http://www.siri.org.uk/siri"
        prefix: siri
      required:
        - summaryContent
        - descriptionContent
        - consequenceContent
        - recommendationContent
        - remarkContent
        - infoLink
      properties:
        summaryContent:
          type: object
          xml:
            name: SummaryContent
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
          required:
            - summaryText
          properties:
            summaryText:
              type: string
              xml:
                name: SummaryText
                namespace: "http://www.siri.org.uk/siri"
                prefix: siri
        reasonContent:
          type: object
          xml:
            name: ReasonContent
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
          required:
            - reasonText
          properties:
            reasonText:
              type: string
              xml:
                name: ReasonText
                namespace: "http://www.siri.org.uk/siri"
                prefix: siri
        descriptionContent:
          type: array
          items:
            type: object
            xml:
              name: DescriptionContent
              namespace: "http://www.siri.org.uk/siri"
              prefix: siri
            required:
              - descriptionText
            properties:
              descriptionText:
                type: string
                xml:
                  name: DescriptionText
                  namespace: "http://www.siri.org.uk/siri"
                  prefix: siri
        consequenceContent:
          type: array
          items:
            type: object
            xml:
              name: ConsequenceContent
              namespace: "http://www.siri.org.uk/siri"
              prefix: siri
            required:
              - consequenceText
            properties:
              consequenceText:
                type: string
                xml:
                  name: ConsequenceText
                  namespace: "http://www.siri.org.uk/siri"
                  prefix: siri
        recommendationContent:
          type: array
          items:
            type: object
            xml:
              name: RecommendationContent
              namespace: "http://www.siri.org.uk/siri"
              prefix: siri
            required:
              - recommendationText
            properties:
              recommendationText:
                type: string
                xml:
                  name: RecommendationText
                  namespace: "http://www.siri.org.uk/siri"
                  prefix: siri
        durationContent:
          type: object
          xml:
            name: DurationContent
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
          required:
            - durationText
          properties:
            durationText:
              type: string
              xml:
                name: DurationText
                namespace: "http://www.siri.org.uk/siri"
                prefix: siri
        remarkContent:
          type: array
          items:
            type: object
            xml:
              name: RemarkContent
              namespace: "http://www.siri.org.uk/siri"
              prefix: siri
            required:
              - remark
            properties:
              remark:
                type: string
                xml:
                  name: Remark
                  namespace: "http://www.siri.org.uk/siri"
                  prefix: siri
        infoLink:
          type: array
          items:
            # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__InfoLinkStructure
            type: object
            xml:
              name: InfoLink
              namespace: "http://www.siri.org.uk/siri"
              prefix: siri
            required:
              - uri
            properties:
              uri:
                type: string
                xml:
                  name: Uri
                  namespace: "http://www.siri.org.uk/siri"
                  prefix: siri
              label:
                type: array
                xml:
                  name: Label
                items:
                  type: string
                  xml:
                    name: Label
                    namespace: "http://www.siri.org.uk/siri"
                    prefix: siri

    # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__PassengerInformationActionStructure
    PassengerInformationActionStructure:
      type: object
      xml:
        name: PassengerInformationAction
        namespace: "http://www.siri.org.uk/siri"
        prefix: siri
      required:
        - actionRef
        - recordedAtTime
        - perspective
        - textualContent
      properties:
        actionRef:
          type: string
          xml:
            name: ActionRef
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        recordedAtTime:
          type: string
          xml:
            name: RecordedAtTime
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        perspective:
          $ref: "#/components/schemas/PerspectiveEnum"
          xml:
            name: Perspective
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        textualContent:
          type: array
          xml:
            name: TextualContent
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
          items:
            $ref: "#/components/schemas/TextualContentStructure"
    
    # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__PublishingActionStructure
    ActionsStructure:
      type: object
      xml:
        name: PublishingAction
        namespace: "http://www.siri.org.uk/siri"
        prefix: siri
      required:
        - publishAtScope
        - passengerInformationAction
      properties:
        publishAtScope:
          type: object
          required:
            - scopeType
          xml:
            name: PublishAtScope
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
          properties:
            scopeType:
              # TODO - make it enum - local-type: typedef-50.4
              type: string
              xml:
                name: ScopeType
                namespace: "http://www.siri.org.uk/siri"
                prefix: siri
        passengerInformationAction:
          type: array
          xml:
            name: PassengerInformationAction
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
          items:
            $ref: "#/components/schemas/PassengerInformationActionStructure"
    
    # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__PtSituationElementStructure
    PtSituationElementStructure:
      type: object
      xml:
        name: PtSituationElement
        namespace: "http://www.siri.org.uk/siri"
        prefix: siri
      required:
        - creationTime
        - situationNumber
        - source
        - validityPeriod
        - alertCause
      properties:
        creationTime:
          type: string
          xml:
            name: CreationTime
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        participantRef:
          type: string
          xml:
            name: ParticipantRef
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        situationNumber:
          type: string
          xml:
            name: SituationNumber
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        version:
          type: number
          xml:
            name: Version
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        source:
          type: object
          xml:
            name: Source
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
          required:
            - sourceType
          properties:
            sourceType:
              $ref: "#/components/schemas/SituationSourceTypeEnum"
              xml:
                name: SourceType
                namespace: "http://www.siri.org.uk/siri"
                prefix: siri
        validityPeriod:
          type: array
          xml:
            name: ValidityPeriod
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
          items:
            # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__HalfOpenTimestampOutputRangeStructure
            type: object
            xml:
              name: HalfOpenTimestampOutputRangeStructure
              namespace: "http://www.siri.org.uk/siri"
              prefix: siri
            required:
              - startTime
            properties:
              startTime:
                type: string
                xml:
                  name: StartTime
                  namespace: "http://www.siri.org.uk/siri"
                  prefix: siri
              endTime:
                type: string
                xml:
                  name: EndTime
                  namespace: "http://www.siri.org.uk/siri"
                  prefix: siri
        alertCause:
          # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__AlertCauseEnumeration
          # TODO - make it enum
          type: string
          xml:
            name: AlertCause
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        priority:
          type: string
          xml:
            name: Priority
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        scopeType:
          # TODO - make it enum - local-type: typedef-50.4
          type: string
          xml:
            name: ScopeType
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__ActionsStructure
        publishingActions:
          type: object
          xml:
            name: PublishingActions
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
          required:
            - publishingAction
          properties:
            publishingAction:
              type: array
              items:
                $ref: "#/components/schemas/ActionsStructure"
              xml:
                name: PublishingAction
                namespace: "http://www.siri.org.uk/siri"
                prefix: siri
    
    SharedServiceArrivalDeparture:
      type: object
      xml:
        name: SharedServiceArrivalDeparture
        wrapped: false
      required:
        - timetabledTime
      properties:
        timetabledTime:
          type: string
          xml:
            name: TimetabledTime
        estimatedTime:
          type: string
          xml:
            name: EstimatedTime

    # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__VehicleOccupancyStructure
    ExpectedDepartureOccupancyStructure:
      type: object
      xml:
        name: ExpectedDepartureOccupancy
      required:
        - fareClass
        - occupancyLevel
      properties:
        fareClass:
          $ref: "#/components/schemas/FareClassEnum"
          xml:
            name: FareClass
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        occupancyLevel:
          $ref: "#/components/schemas/OccupancyLevelEnum"
          xml:
            name: OccupancyLevel
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__LegBoardStructure
    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__CallAtStopStructure
    CallAtStop:
      type: object
      xml:
        name: CallAtStop
      required:
        - stopPointRef
        - stopPointName
      properties:
        stopPointRef:
          type: string
          xml:
            name: StopPointRef
        stopPointName:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: StopPointName
        nameSuffix:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: NameSuffix
        plannedQuay:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: PlannedQuay
        estimatedQuay:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: EstimatedQuay
        serviceArrival:
          $ref: '#/components/schemas/SharedServiceArrivalDeparture'
          xml:
            name: ServiceArrival
        serviceDeparture:
          $ref: '#/components/schemas/SharedServiceArrivalDeparture'
          xml:
            name: ServiceDeparture
        order:
          type: number
          xml:
            name: Order
        requestStop:
          type: boolean
          xml:
            name: RequestStop
        unplannedStop:
          type: boolean
          xml:
            name: UnplannedStop
        notServicedStop:
          type: boolean
          xml:
            name: NotServicedStop
        noBoardingAtStop:
          type: boolean
          xml:
            name: NoBoardingAtStop
        noAlightingAtStop:
          type: boolean
          xml:
            name: NoAlightingAtStop
        expectedDepartureOccupancy:
          type: array
          xml:
            name: ExpectedDepartureOccupancy
          items:
            $ref: "#/components/schemas/ExpectedDepartureOccupancyStructure"
    # SharedLegSection

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__CallAtNearStopStructure
    CallAtNearStop:
      type: object
      xml:
        name: CallAtNearStop
      required:
        - callAtStop
      properties:
        callAtStop:
          $ref: '#/components/schemas/CallAtStop'
          xml:
            name: CallAtStop

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__ProductCategoryStructure
    ProductCategory:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: Name
        shortName:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: ShortName
        productCategoryRef:
          type: string
          xml:
            name: ProductCategoryRef

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__GeneralAttributeStructure
    GeneralAttribute:
      type: object
      xml:
        name: Attribute
      required:
        - userText
        - code
      properties:
        userText:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: UserText
        code:
          type: string
          xml:
            name: Code
        hireFacility:
          type: string
          xml:
            name: HireFacility
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        importance:
          type: number
          xml:
            name: Importance

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__SituationFullRefStructure
    SituationFullRefStructure:
      type: object
      xml:
        name: SituationFullRef
      required:
        - participantRef
        - situationNumber
      properties:
        participantRef:
          type: string
          xml:
            name: ParticipantRef
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        situationNumber:
          type: string
          xml:
            name: SituationNumber
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__DatedJourneyStructure
    DatedJourney:
      type: object
      xml:
        name: Service
      required:
        - operatingDayRef
        - journeyRef
        - lineRef
        - mode
        - attribute
        - publishedServiceName
        - originText
      properties:
        conventionalModeOfOperation:
          type: string
          xml:
            name: ConventionalModeOfOperation
        operatingDayRef:
          type: string
          xml:
            name: OperatingDayRef
        journeyRef:
          type: string
          xml:
            name: JourneyRef
        publicCode:
          type: string
          xml:
            name: PublicCode
        lineRef:
          type: string
          xml:
            name: LineRef
        directionRef:
          type: string
          xml:
            name: DirectionRef
        mode:
          $ref: '#/components/schemas/ModeStructure'
          xml:
            name: Mode
        productCategory:
          $ref: '#/components/schemas/ProductCategory'
          xml:
            name: ProductCategory
        publishedServiceName:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: PublishedServiceName
        trainNumber:
          type: string
          xml:
            name: TrainNumber
        attribute:
          type: array
          xml:
            name: Attribute
          items:
            $ref: "#/components/schemas/GeneralAttribute"
        originText:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: OriginText
        operatorRef:
          type: string
          xml:
            name: OperatorRef
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        destinationStopPointRef:
          type: string
          xml:
            name: DestinationStopPointRef
        destinationText:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: DestinationText
        unplanned:
          type: boolean
          xml:
            name: Unplanned
        cancelled:
          type: boolean
          xml:
            name: Cancelled
        deviation:
          type: boolean
          xml:
            name: Deviation
        situationFullRefs:
          type: object
          xml:
            name: SituationFullRefs
          required:
            - situationFullRef
          properties:
            situationFullRef:
              type: array
              xml:
                name: SituationFullRef
              items:
                $ref: "#/components/schemas/SituationFullRefStructure"
    # DatedJourney

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__ResponseContextStructure
    ResponseContextStructure:
      type: object
      xml:
        name: ResponseContext
      properties:
        places:
          type: object
          xml:
            name: Places
          required:
            - place
          properties:
            place:
              type: array
              xml:
                name: Place
              items:
                $ref: '#/components/schemas/Place'
        situations:
          type: object
          xml:
            name: Situations
          required:
            - ptSituation
          properties:
            ptSituation:
              type: array
              xml:
                name: PtSituation
              items:
                $ref: '#/components/schemas/PtSituationElementStructure'

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__LinearShapeStructure
    LinkProjection:
      type: object
      xml:
        name: LinkProjection
      required:
        - position
      properties:
        position:
          type: array
          xml:
            name: Position
          items:
            $ref: '#/components/schemas/GeoPosition'

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__TrackSectionStructure
    TrackSectionStructure:
      type: object
      xml:
        name: TrackSection
      properties:
        trackSectionStart:
          $ref: '#/components/schemas/PlaceRef'
          xml:
            name: TrackSectionStart
        trackSectionEnd:
          $ref: '#/components/schemas/PlaceRef'
          xml:
            name: TrackSectionEnd
        linkProjection:
          $ref: '#/components/schemas/LinkProjection'
          xml:
            name: LinkProjection
        roadName:
          type: string
          xml:
            name: RoadName
        duration:
          type: string
          xml:
            name: Duration
        length:
          type: number
          xml:
            name: Length

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__LegTrackStructure
    LegTrackStructure:
      type: object
      xml:
        name: LegTrack
      required:
        - trackSection
      properties:
        trackSection:
          type: array
          xml:
            name: TrackSection
          items:
            $ref: '#/components/schemas/TrackSectionStructure'

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__PointOfInterestFilterStructure
    PointOfInterestFilterStructure:
      type: object
      required:
        - pointOfInterestCategory
      xml:
        name: PointOfInterestFilter
      properties:
        exclude:
          type: boolean
          xml:
            name: Exclude
        pointOfInterestCategory:
          type: array
          xml:
            name: PointOfInterestCategory
          items:
            $ref: "#/components/schemas/PointOfInterestCategoryStructure"

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__ModeFilterStructure
    ModeFilterStructure:
      type: object
      xml:
        name: ModeFilter
      required:
        - ptMode
        - personalMode
      properties:
        exclude:
          type: boolean
          xml:
            name: Exclude
        ptMode:
          type: array
          xml:
            name: PtMode
          items:
            $ref: '#/components/schemas/VehicleModesOfTransportEnum'
        personalMode:
          type: array
          xml:
            name: PersonalMode
          items:
            $ref: './ojp-shared.yml#/components/schemas/PersonalModesEnumeration'
        airSubmode:
          type: string
          xml:
            name: AirSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        busSubmode:
          type: string
          xml:
            name: BusSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        coachSubmode:
          type: string
          xml:
            name: CoachSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        funicularSubmode:
          type: string
          xml:
            name: FunicularSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        metroSubmode:
          type: string
          xml:
            name: MetroSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        tramSubmode:
          type: string
          xml:
            name: TramSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        telecabinSubmode:
          type: string
          xml:
            name: telecabinSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        railSubmode:
          $ref: "#/components/schemas/RailSubmodeEnum"
          xml:
            name: RailSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        waterSubmode:
          type: string
          xml:
            name: WaterSubmode
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri

    # https://vdvde.github.io/OJP/develop/documentation-tables/siri.html#type_siri__LineDirectionStructure
    LineDirectionStructure:
      type: object
      xml:
        name: Line
      required:
        - lineRef
      properties:
        lineRef:
          type: string
          xml:
            name: LineRef
            prefix: siri
        directionRef:
          type: string
          xml:
            name: DirectionRef
            prefix: siri
    
    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__LineDirectionFilterStructure
    LineDirectionFilterStructure:
      type: object
      xml:
        name: LineFilter
      required:
        - line
      properties:
        line:
          type: array
          xml:
            name: Line
          items:
            $ref: '#/components/schemas/LineDirectionStructure'
        exclude:
          type: boolean
          xml:
            name: Exclude

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__OperatorFilterStructure
    OperatorFilterStructure:
      type: object
      xml:
        name: OperatorFilter
      required:
        - operatorRef
      properties:
        exclude:
          type: boolean
          xml:
            name: Exclude
        operatorRef:
          type: array
          xml:
            name: OperatorRef
          items:
            type: string
            xml:
              name: OperatorRef

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__VehicleFilterStructure
    VehicleFilterStructure:
      type: object
      xml:
        name: VehicleFilter
      required:
        - vehicleRef
        - trainNumber
      properties:
        exclude:
          type: boolean
          xml:
            name: Exclude
        vehicleRef:
          type: array
          xml:
            name: VehicleRef
          items:
            type: string
            xml:
              name: VehicleRef
        trainNumber:
          type: array
          xml:
            name: TrainNumber
          items:
            type: string
            xml:
              name: TrainNumber

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__GeoRestrictionsStructure
    GeoRestrictionsStructure:
      type: object
      xml:
        name: GeoRestrictions
      required:
        - rectangle
      properties:
        rectangle:
          type: object
          xml:
            name: Rectangle
          required:
            - upperLeft
            - lowerRight
          properties:
            upperLeft:
              $ref: '#/components/schemas/GeoPosition'
              xml:
                name: UpperLeft
            lowerRight:
              $ref: '#/components/schemas/GeoPosition'
              xml:
                name: LowerRight

    BookingArrangementStructure:
      type: object
      xml:
        name: BookingArrangement
      required:
        - bookingAgencyName
        - infoUrl
      properties:
        bookingAgencyName:
          $ref: '#/components/schemas/InternationalText'
          xml:
            name: BookingAgencyName
        infoUrl:
          type: string
          xml:
            name: InfoUrl

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__ContinuousServiceStructure
    ContinuousServiceStructure:
      type: object
      required:
        - personalModeOfOperation
        - personalMode
      xml:
        name: ContinuousService
      properties:
        personalModeOfOperation:
          $ref: './ojp-shared.yml#/components/schemas/PersonalModesOfOperationEnumeration'
          xml:
            name: PersonalModeOfOperation
        personalMode:
          $ref: './ojp-shared.yml#/components/schemas/PersonalModesEnumeration'
          xml:
            name: PersonalMode
        mode:
          $ref: "./ojp-shared.yml#/components/schemas/ModeFilterStructure"
          xml:
            name: Mode
        bookingArrangements:
          type: object
          xml:
            name: BookingArrangements
          required:
            - bookingArrangement
          properties:
            bookingArrangement:
              type: array
              items:
                $ref: './ojp-shared.yml#/components/schemas/BookingArrangementStructure'