Skip to content

Commit

Permalink
Merge branch 'changes_for_v1.1' into tariffzones-to-use
Browse files Browse the repository at this point in the history 
# Conflicts:
#	docs/generated/index.html
  • Loading branch information
@sgrossberndt
sgrossberndt committed Dec 16, 2022
2 parents 99ac6f8 + de6a4da commit 83fa48e
Show file tree
Hide file tree
Showing 15 changed files with 687 additions and 103 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/deploy-pages.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Deploy documentation tables

on:
push:
branches: ["changes_for_v1.1"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: './docs/generated'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
19 changes: 12 additions & 7 deletions OJP/OJP_Common.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,28 @@
<xs:annotation>
<xs:documentation>========================================== General ==========================================</xs:documentation>
</xs:annotation>
<xs:complexType name="ErrorMessageStructure">
<xs:group name="ProblemDetailGroup">
<xs:annotation>
<xs:documentation>Structured error messages</xs:documentation>
<xs:documentation>Detailed description of the problem.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Code" type="xs:normalizedString">
<xs:element name="Title" type="InternationalTextStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Code of the error situation.</xs:documentation>
<xs:documentation>Title of the problem.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Text" type="InternationalTextStructure" minOccurs="0">
<xs:element name="Details" type="InternationalTextStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Description of the error situation.</xs:documentation>
<xs:documentation>Explanation of the problem.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="LogData" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Additional log data.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:group>
<xs:complexType name="PrivateCodeStructure">
<xs:annotation>
<xs:documentation>Code within scope of a private referential system</xs:documentation>
Expand Down
10 changes: 5 additions & 5 deletions OJP/OJP_Fare.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,11 @@
<xs:documentation>ID of this result.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Problem" type="FareProblemStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Problems related to this FARE result.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice>
<xs:element name="StopFareResult" type="StopFareResultStructure">
<xs:annotation>
Expand Down Expand Up @@ -207,11 +212,6 @@
<xs:documentation>Structure of a Multi Trip Fare Request result</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="ErrorMessage" type="ErrorMessageStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Result-specific error messages.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TripFareProductReference" type="TripFareProductReferenceStructure" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Non-empty list of trip references in the corresponding MultiTripFareRequestStructure</xs:documentation>
Expand Down
73 changes: 68 additions & 5 deletions OJP/OJP_FareSupport.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -389,11 +389,6 @@
<xs:documentation>Structure of a Single Trip Fare Request result</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="ErrorMessage" type="ErrorMessageStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Result-specific error messages </xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="TripLegRangeGroup" minOccurs="0"/>
<xs:element name="PassedZones" type="TariffZoneListInAreaStructure" minOccurs="0">
<xs:annotation>
Expand Down Expand Up @@ -486,4 +481,72 @@
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:annotation>
<xs:documentation>========================================== Problems ==========================================</xs:documentation>
</xs:annotation>
<xs:simpleType name="FareProblemTypeEnumeration">
<xs:annotation>
<xs:documentation>Types of problems that may be returned in responses to FARE requests.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="FARE_OUTOFAREA">
<xs:annotation>
<xs:documentation>The trip planning has found a route that leaves the area of the fare authority.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="FARE_JOURNEYNOTPERMITTED">
<xs:annotation>
<xs:documentation>The trip planning result suggests a service which is not permitted by the fare authority.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="FARE_ADDITIONALCHARGES">
<xs:annotation>
<xs:documentation>Passengers may be charged additional fees (e.g.: for road tolls or seat reservation).</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="FARE_ADDITIONALTICKETS">
<xs:annotation>
<xs:documentation>Additional tickets may be necessary because only parts of the passenger trip could be covered.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="FARE_ROUTENOTFEASIBLE">
<xs:annotation>
<xs:documentation>Fare calculation is not possible because the suggested trip is not in compliance with the fare regulations, e.g. because of round trips, TripLegs that go forth and return or exceed the maximal total trip duration.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="FARE_ALREADYCOVERED">
<xs:annotation>
<xs:documentation>The ticket that has been specified in the request is valid for the suggested trip (or parts of it as defined by TripLegRange).</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="FARE_DATEOUTOFRANGE">
<xs:annotation>
<xs:documentation>The fare request cannot be processed because there is no information available for the requested date.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="FARE_STOPPOINTUNKNOWN">
<xs:annotation>
<xs:documentation>The fare request cannot be processed because the requested stop is unknown.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="FARE_OTHER">
<xs:annotation>
<xs:documentation>A problem has occurred that does not have a specific problem type.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="FareProblemStructure">
<xs:annotation>
<xs:documentation>Problem that may be returned in responses to FARE requests.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Type" type="FareProblemTypeEnumeration">
<xs:annotation>
<xs:documentation>Type of the FARE problem.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="ProblemDetailGroup"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
23 changes: 23 additions & 0 deletions OJP/OJP_JourneySupport.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,24 @@
</xs:element>
</xs:sequence>
</xs:group>
<xs:simpleType name="ReservationNeededEnumeration">
<xs:annotation>
<xs:documentation>Possible types of reservation needed for services.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="none"/>
<xs:enumeration value="service">
<xs:annotation>
<xs:documentation>A reservation/booking is required for the service to operate. BookingArrangement should then be used and contain more details.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="stop">
<xs:annotation>
<xs:documentation>A reservation/booking is required for the service to call at the stop for boarding and alighting. BookingArrangement should then be used and contain more details.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="DatedJourneyStructure">
<xs:annotation>
<xs:documentation>[equivalent to DATED VEHICLE JOURNEY in TMv6] passenger carrying VEHICLE JOURNEY for one specified DAY TYPE for which the pattern of working is in principle defined by a SERVICE JOURNEY PATTERN. DatedJourney details of a service include its operating days. </xs:documentation>
Expand All @@ -208,6 +226,11 @@
<xs:documentation>Container with information on booking possibilities for this service.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ReservationNeeded" type="ReservationNeededEnumeration" default="none" minOccurs="0">
<xs:annotation>
<xs:documentation>Indicates whether this service needs some kind of reservation or booking to run.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="SituationFullRef" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="Extension" type="xs:anyType" minOccurs="0"/>
</xs:sequence>
Expand Down
103 changes: 103 additions & 0 deletions OJP/OJP_PlaceSupport.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -467,4 +467,107 @@
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:annotation>
<xs:documentation>========================================== Problems ==========================================</xs:documentation>
</xs:annotation>
<xs:simpleType name="LocationProblemTypeEnumeration">
<xs:annotation>
<xs:documentation>Types of problems that may be returned in responses to LOCATION requests.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="LOCATION_NORESULTS">
<xs:annotation>
<xs:documentation>No location objects could be found that match the input data.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="LOCATION_UNSUPPORTEDTYPE">
<xs:annotation>
<xs:documentation>The requested location types are not supported by the service.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="LOCATION_UNSUPPORTEDCOMBINATION">
<xs:annotation>
<xs:documentation>The combination of input data (text string, coordinates, geographical restrictions) cannot be processed by the service.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="LOCATION_NOREFINEMENT">
<xs:annotation>
<xs:documentation>The given location object could not be refined.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="LOCATION_USAGEIGNORED">
<xs:annotation>
<xs:documentation>The usage type has been ignored.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="LOCATION_UNSUPPORTEDPTMODES">
<xs:annotation>
<xs:documentation>The service does not support any restrictions by transport modes.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="LOCATION_UNSUPPORTEDLOCALITY">
<xs:annotation>
<xs:documentation>The service does not support any restrictions by localities.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="LOCATION_OTHER">
<xs:annotation>
<xs:documentation>A problem has occurred that does not have a specific problem type.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="LocationProblemStructure">
<xs:annotation>
<xs:documentation>Problem that may be returned in responses to LOCATION requests.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Type" type="LocationProblemTypeEnumeration">
<xs:annotation>
<xs:documentation>Type of the LOCATION problem.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="ProblemDetailGroup"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="ExchangePointsProblemTypeEnumeration">
<xs:annotation>
<xs:documentation>Types of problems that may be returned in responses to EXCHANGE POINTS requests</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="EXCHANGEPOINTS_NORESULTS">
<xs:annotation>
<xs:documentation>No exchange points could be found that match the query criteria.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="EXCHANGEPOINTS_UNKNOWNDESTINATIONSYSTEM">
<xs:annotation>
<xs:documentation>The destination system given in the request parameters is unknown.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="EXCHANGEPOINTS_UNKNOWNADJACENTSYSTEM">
<xs:annotation>
<xs:documentation>One or more of the adjacent systems given in the request parameters are unknown.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="EXCHANGEPOINTS_OTHER">
<xs:annotation>
<xs:documentation>A problem has occurred that does not have a specific problem type.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="ExchangePointProblemStructure">
<xs:annotation>
<xs:documentation>Problem that may be returned in responses to EXCHANGE POINTS requests.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Type" type="ExchangePointsProblemTypeEnumeration">
<xs:annotation>
<xs:documentation>Type of the EXCHANGE POINTS problem.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="ProblemDetailGroup"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
16 changes: 13 additions & 3 deletions OJP/OJP_Places.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,11 @@
</xs:complexType>
<xs:complexType name="PlaceResultStructure">
<xs:sequence>
<xs:element name="Problem" type="LocationProblemStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Problems related to this LOCATION result.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Place" type="PlaceStructure"/>
<xs:element name="Complete" type="xs:boolean">
<xs:annotation>
Expand Down Expand Up @@ -152,7 +157,7 @@
</xs:element>
<xs:element name="NumberOfResults" type="xs:positiveInteger" minOccurs="0">
<xs:annotation>
<xs:documentation>Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (eg: in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The place information service is expected to support a response volume of at least 500 objects within one single response.</xs:documentation>
<xs:documentation>Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g.: in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The place information service is expected to support a response volume of at least 500 objects within one single response.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ContinueAt" type="xs:nonNegativeInteger" minOccurs="0">
Expand Down Expand Up @@ -324,17 +329,22 @@
</xs:group>
<xs:complexType name="ExchangePointsResultStructure">
<xs:sequence>
<xs:element name="Problem" type="ExchangePointProblemStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Problems related to this EXCHANGE POINTS result.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Place" type="PlaceStructure">
<xs:annotation>
<xs:documentation>Place object that describes this exchange point.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TravelDurationEstimate" type="xs:duration" minOccurs="0">
<xs:annotation>
<xs:documentation>Rough estimate of the travel duration from the specified refrence place to this exchange point.</xs:documentation>
<xs:documentation>Rough estimate of the travel duration from the specified reference place to this exchange point.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="WaitDuration" type="xs:duration" minOccurs="0" default="PT0M">
<xs:element name="WaitDuration" type="xs:duration" default="PT0M" minOccurs="0">
<xs:annotation>
<xs:documentation>Duration needed at this exchange point to change from one service to another. If a journey planning orchestrator puts together a trip at this exchange point, it has to take care, that feeding arrival and fetching departure are at least this duration apart.</xs:documentation>
</xs:annotation>
Expand Down
Loading

0 comments on commit 83fa48e

Please sign in to comment.