jentic-openapi-validator-spectral 1.0.0a14__tar.gz → 1.0.0a16__tar.gz

{jentic_openapi_validator_spectral-1.0.0a14 → jentic_openapi_validator_spectral-1.0.0a16}/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.4
 Name: jentic-openapi-validator-spectral
-Version: 1.0.0a14
+Version: 1.0.0a16
 Summary: Jentic OpenAPI Spectral Validator Backend
 Author: Jentic
 Author-email: Jentic <hello@jentic.com>
 License-Expression: Apache-2.0
 License-File: LICENSE
 License-File: NOTICE
-Requires-Dist: jentic-openapi-common~=1.0.0a14
-Requires-Dist: jentic-openapi-validator~=1.0.0a14
+Requires-Dist: jentic-openapi-common~=1.0.0a16
+Requires-Dist: jentic-openapi-validator~=1.0.0a16
 Requires-Dist: lsprotocol~=2025.0.0
 Requires-Python: >=3.11
 Project-URL: Homepage, https://github.com/jentic/jentic-openapi-tools

{jentic_openapi_validator_spectral-1.0.0a14 → jentic_openapi_validator_spectral-1.0.0a16}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "jentic-openapi-validator-spectral"
-version = "1.0.0-alpha.14"
+version = "1.0.0-alpha.16"
 description = "Jentic OpenAPI Spectral Validator Backend"
 readme = "README.md"
 authors = [{ name = "Jentic", email = "hello@jentic.com" }]
@@ -8,8 +8,8 @@ license = "Apache-2.0"
 license-files = ["LICENSE", "NOTICE"]
 requires-python = ">=3.11"
 dependencies = [
-  "jentic-openapi-common~=1.0.0-alpha.14",
-  "jentic-openapi-validator~=1.0.0-alpha.14",
+  "jentic-openapi-common~=1.0.0-alpha.16",
+  "jentic-openapi-validator~=1.0.0-alpha.16",
   "lsprotocol~=2025.0.0"
 ]
 
@@ -36,4 +36,4 @@ build-backend = "uv_build"
 spectral = "jentic.apitools.openapi.validator.backends.spectral:SpectralValidatorBackend"
 
 [tool.setuptools.package-data]
-"jentic.apitools.openapi.validator.backends.spectral" = ["rulesets/*.yaml", "rulesets/*.yml"]
+"jentic.apitools.openapi.validator.backends.spectral" = ["rulesets/*.yaml", "rulesets/*.yml", "rulesets/*.mjs"]

{jentic_openapi_validator_spectral-1.0.0a14 → jentic_openapi_validator_spectral-1.0.0a16}/src/jentic/apitools/openapi/validator/backends/spectral/__init__.py

@@ -23,7 +23,7 @@ __all__ = ["SpectralValidatorBackend"]
 
 
 rulesets_files_dir = files("jentic.apitools.openapi.validator.backends.spectral.rulesets")
-ruleset_file = rulesets_files_dir.joinpath("spectral.yaml")
+ruleset_file = rulesets_files_dir.joinpath("spectral.mjs")
 
 
 class SpectralValidatorBackend(BaseValidatorBackend):
@@ -124,11 +124,12 @@ class SpectralValidatorBackend(BaseValidatorBackend):
             )
 
             # Validate ruleset path if it's a filesystem path (skip non-path URIs)
+            # Spectral supports YAML, JSON, and JavaScript module formats
             validated_ruleset_path = (
                 validate_path(
                     self.ruleset_path,
                     allowed_base=self.allowed_base_dir,
-                    allowed_extensions=(".yaml", ".yml"),
+                    allowed_extensions=(".yaml", ".yml", ".js", ".mjs", ".cjs"),
                 )
                 if self.ruleset_path is not None and is_path(self.ruleset_path)
                 else self.ruleset_path

jentic_openapi_validator_spectral-1.0.0a16/src/jentic/apitools/openapi/validator/backends/spectral/rulesets/openapi.json

@@ -0,0 +1,814 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "Irish Rail Realtime API",
+    "description": "API for accessing Irish Rail real-time information    \n",
+    "version": "1.0.1"
+  },
+  "paths": {
+    "/stations": {
+      "get": {
+        "summary": "Get All Stations optionally filtered by `StationType`",
+        "description": "When provided with no parameters, it returns a list of all stations in XML format. When provided with a `StationType`, it returns a list of all stations of that type in XML format. ",
+        "operationId": "get_all_stations_by_type_getStations_get",
+        "parameters": [
+          {
+            "name": "StationType",
+            "in": "query",
+            "description": "Station type filter (A=All, D=Dart, M=Mainline, S=Suburban, Else=All)",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "description": "Station type filter (A=All, D=Dart, M=Mainline, S=Suburban, Else=All)",
+              "enum": [
+                "A",
+                "D",
+                "M",
+                "S"
+              ],
+              "title": "StationType"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "List of Stations (XML)",
+            "content": {
+              "application/xml": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/objStation"
+                  },
+                  "xml": {
+                    "name": "ArrayOfObjStation",
+                    "namespace": "http://api.irishrail.ie/realtime/",
+                    "wrapped": true
+                  }
+                },
+                "examples": {
+                  "stations": {
+                    "summary": "List of stations",
+                    "value": "<arrayOfObjStation xmlns=\"http://api.irishrail.ie/realtime/\">\n  <objStation>\n    <StationDesc>Belfast</StationDesc>\n    <StationAlias/>\n    <StationLatitude>54.6123</StationLatitude>\n    <StationLongitude>-5.91744</StationLongitude>\n    <StationCode>BFSTC</StationCode>\n    <StationId>228</StationId>\n  </objStation>\n  <objStation>\n    <StationDesc>Lisburn</StationDesc>\n    <StationAlias/>\n    <StationLatitude>54.514</StationLatitude>\n    <StationLongitude>-6.04327</StationLongitude>\n    <StationCode>LBURN</StationCode>\n    <StationId>238</StationId>\n  </objStation>\n  <objStation>\n    <StationDesc>Lurgan</StationDesc>\n    <StationAlias/>\n    <StationLatitude>54.4672</StationLatitude>\n    <StationLongitude>-6.33547</StationLongitude>\n    <StationCode>LURGN</StationCode>\n    <StationId>241</StationId>\n  </objStation>\n</arrayOfObjStation>"
+                  }
+                }
+              }
+            }
+          },
+          "422": {
+            "$ref": "#/components/responses/HTTP422Response"
+          },
+          "500": {
+            "$ref": "#/components/responses/HTTP500Response"
+          }
+        }
+      }
+    },
+    "/station-timetables": {
+      "get": {
+        "summary": "Get Station timetable info based on `StationCode` or `StationName`.",
+        "description": "Returns a list of station data based on the provided `StationCode` or `StationName`. The station data provides a timetable (arrivals and departures at the station) in XML format. \nWhen a `NumMins` parameter is provided, the returned data is limited to the next NumMins of minutes in XML format. \n**Note:** A `StationCode` or `StationName` MUST be specified.",
+        "operationId": "get_station_by_code_with_mins_getStationTimetable_code_get",
+        "parameters": [
+          {
+            "name": "StationCode",
+            "description": "Station Code",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": ["BFSTC", "LBURN", "LURGN", "PDOWN", "SLIGO", "NEWRY", "COLNY", "BALNA", "BMOTE", "DDALK", "FXFRD", "BOYLE", "CKOSH", "DRMOD", "CLBAR", "MNLAJ", "WPORT", "BYHNS", "CSREA", "LFORD", "CLMRS", "DGHDA", "ETOWN", "LTOWN", "GSTON", "RSCMN", "BBRGN", "SKRES", "MLGAR", "RLUSK", "DBATE", "MHIDE", "M3WAY", "ATLNE", "DBYNE", "PMNCK", "ENFLD", "KCOCK", "GRGRD", "SUTTN", "BYSDE", "HWTHJ", "HOWTH", "KBRCK", "HAFLD", "CLSLA", "CNOCK", "RAHNY", "HTOWN", "MYNTH", "PHNPK", "CMINE", "ASHTN", "PELTN", "LXCON", "KLSTR", "BBRDG", "LXLSA", "DCDRA", "CTARF", "CNLLY", "DCKLS", "TARA", "HSTON", "PERSE", "WLAWN", "GCDK", "CLARA", "BSLOE", "ADAMS", "ADAMF", "ADMTN", "LDWNE", "KISHO", "KISHF", "KISHS", "PWESF", "PWESS", "CHORC", "CLDKN", "CLONS", "CLONF", "SMONT", "HZLCH", "HAZEF", "HAZES", "ATMON", "SIDNY", "BTSTN", "BROCK", "ATHRY", "SEAPT", "SHILL", "DLERY", "SCOVE", "GLGRY", "DLKEY", "ORNMR", "GALWY", "TMORE", "KILNY", "SALNS", "SKILL", "CRGHW", "WBROK", "BRAY", "NBRGE", "CURAH", "KDARE", "ARHAN", "PTRTN", "MONVN", "GSTNS", "KCOOL", "GORT", "PTLSE", "ATHY", "WLOW", "RCREA", "CJRDN", "RDRUM", "BBRHY", "NNAGH", "CRLOW", "ENNIS", "ARKLW", "TPMOR", "BHILL", "SXMBR", "CCONL", "MNEBG", "THRLS", "GOREY", "LMRCK", "KKNNY", "THTWN", "ECRTY", "LMRKJ", "TIPRY", "CAHIR", "CLMEL", "CKOSR", "CVILL", "WXFRD", "CPILE", "BCLAN", "RLSTD", "TRLEE", "WBDGE", "WFORD", "RLEPT", "BRGTN", "FFORE", "MLLOW", "BTEER", "RMORE", "MLSRT", "KLRNY", "MDLTN", "CGTWL", "GHANE", "LSLND", "CORK", "FOTA", "CGLOE", "RBROK", "COBH", "CITYJ", "CENTJ", "DUNMR", "MOIRA"],
+              "description": "Station Code",
+              "title": "StationCode"
+            }
+          },
+          {
+            "name": "StationName",
+            "description": "The Station name",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "NumMins",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "description": "Number of Minutes to filter the data for",
+              "title": "NumMins"
+            },
+            "description": "Number of Minutes"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "List of Station Train Info (XML)",
+            "content": {
+              "application/xml": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/objTrainPositions"
+                  },
+                  "xml": {
+                    "name": "ArrayOfObjStationData",
+                    "namespace": "http://api.irishrail.ie/realtime/",
+                    "wrapped": true
+                  }
+                },
+                "examples": {
+                  "stationsData": {
+                    "summary": "List of station train info",
+                    "value": "<ArrayOfObjStationData xmlns=\"http://api.irishrail.ie/realtime/\">\n  <objStationData>\n      <Servertime>2025-11-03T15:11:02.47</Servertime>\n      <Traincode>P411 </Traincode>\n      <Stationfullname>Dublin Connolly</Stationfullname>\n      <Stationcode>CNLLY</Stationcode>\n      <Querytime>15:11:02</Querytime>\n      <Traindate>03 Nov 2025</Traindate>\n      <Origin>Hazelhatch</Origin>\n      <Destination>Grand Canal Dock</Destination>\n      <Origintime>14:35</Origintime>\n      <Destinationtime>15:23</Destinationtime>\n      <Status>En Route</Status>\n      <Lastlocation>Departed North Strand Junction</Lastlocation>\n      <Duein>3</Duein>\n      <Late>0</Late>\n      <Exparrival>15:13</Exparrival>\n      <Expdepart>15:14</Expdepart>\n      <Scharrival>15:13</Scharrival>\n      <Schdepart>15:14</Schdepart>\n      <Direction>Northbound</Direction>\n      <Traintype>Train</Traintype>\n      <Locationtype>S</Locationtype>\n  </objStationData>\n  <objStationData>\n      <Servertime>2025-11-03T15:11:02.47</Servertime>\n      <Traincode>E826 </Traincode>\n      <Stationfullname>Dublin Connolly</Stationfullname>\n      <Stationcode>CNLLY</Stationcode>\n      <Querytime>15:11:02</Querytime>\n      <Traindate>03 Nov 2025</Traindate>\n      <Origin>Bray</Origin>\n      <Destination>Malahide</Destination>\n      <Origintime>14:25</Origintime>\n      <Destinationtime>15:40</Destinationtime>\n      <Status>En Route</Status>\n      <Lastlocation>Arrived Tara Street</Lastlocation>\n      <Duein>4</Duein>\n      <Late>2</Late>\n      <Exparrival>15:14</Exparrival>\n      <Expdepart>15:15</Expdepart>\n      <Scharrival>15:12</Scharrival>\n      <Schdepart>15:13</Schdepart>\n      <Direction>Northbound</Direction>\n      <Traintype>DART</Traintype>\n      <Locationtype>S</Locationtype>\n  </objStationData>\n</ArrayOfObjStationData>                "
+                  }
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/objTrainPositions"
+                  }
+                },
+                "examples": {
+                  "stationsData": {
+                    "summary": "List of station train info",
+                    "value": {"test": 3}
+                  }
+                }
+              }
+            }
+          },
+          "422": {
+            "$ref": "#/components/responses/HTTP422Response"
+          },
+          "500": {
+            "$ref": "#/components/responses/HTTP500Response"
+          }
+        }
+      }
+    },
+    "/station-summaries": {
+      "get": {
+        "summary": "Get Station Names, Codes, and Descriptions by text filter",
+        "description": "When provided with a StationText, it returns a list of stations with matching text in their names in XML format. Specifically, it returns an array of objStationFilter objects.",
+        "operationId": "get_station_by_filter_getStations_search_get",
+        "parameters": [
+          {
+            "name": "StationText",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "description": "Station Text",
+              "title": "Stationtext"
+            },
+            "description": "Station Text"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "List of StationFiltered Objects (XML)",
+            "content": {
+              "application/xml": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/objStationFilter"
+                  },
+                  "xml": {
+                    "name": "ArrayOfObjStationFilter",
+                    "namespace": "http://api.irishrail.ie/realtime/",
+                    "wrapped": true
+                  }
+                },
+                "examples": {
+                  "stationSummaries": {
+                    "summary": "List of station train info",
+                    "value": "<ArrayOfObjStationFilter xmlns=\"http://api.irishrail.ie/realtime/\">\n  <objStationFilter>\n      <StationDesc_sp>Dublin&nbsp;City&nbsp;Centre</StationDesc_sp>\n      <StationDesc>Dublin City Centre</StationDesc>\n      <StationCode>DUBCE</StationCode>\n  </objStationFilter>\n  <objStationFilter>\n      <StationDesc_sp>Dublin&nbsp;Connolly</StationDesc_sp>\n      <StationDesc>Dublin Connolly</StationDesc>\n      <StationCode>CNLLY</StationCode>\n  </objStationFilter>\n  <objStationFilter>\n      <StationDesc_sp>Dublin&nbsp;Heuston</StationDesc_sp>\n      <StationDesc>Dublin Heuston</StationDesc>\n      <StationCode>HSTON</StationCode>\n  </objStationFilter>\n  <objStationFilter>\n      <StationDesc_sp>Dublin&nbsp;Pearse</StationDesc_sp>\n      <StationDesc>Dublin Pearse</StationDesc>\n      <StationCode>PERSE</StationCode>\n  </objStationFilter>\n</ArrayOfObjStationFilter>                 "
+                  }
+                }
+              }
+            }
+          },
+          "422": {
+            "$ref": "#/components/responses/HTTP422Response"
+          },
+          "500": {
+            "$ref": "#/components/responses/HTTP500Response"
+          }
+        }
+      }
+    },
+    "/trains": {
+      "get": {
+        "summary": "Get Current Trains",
+        "description": "When provided with no parameters, it returns a list of all trains in XML format. When provided with a `TrainType`, it returns a list of all trains of that type in XML format. Specifically, it returns an array of objTrainPositions objects.",
+        "operationId": "get_trains_by_type_getTrains_get",
+        "parameters": [
+          {
+            "name": "TrainType",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "A",
+                "D",
+                "M",
+                "S"
+              ],
+              "description": "Train type filter (A=All, M=Mainline, S=Suburban, D=DART)",
+              "title": "Traintype"
+            },
+            "description": "Train type filter (A=All, M=Mainline, S=Suburban, D=DART)"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "List of Train Objects (XML)",
+            "content": {
+              "application/xml": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/objTrainPositions"
+                  },
+                  "xml": {
+                    "name": "ArrayOfObjTrainPositions",
+                    "namespace": "http://api.irishrail.ie/realtime/",
+                    "wrapped": true
+                  }
+                },
+                "examples": {
+                  "trainPositions": {
+                    "summary": "List of station train info",
+                    "value": "<ArrayOfObjTrainPositions xmlns=\"http://api.irishrail.ie/realtime/\">\n  <objTrainPositions>\n      <TrainStatus>N</TrainStatus>\n      <TrainLatitude>51.8491</TrainLatitude>\n      <TrainLongitude>-8.29956</TrainLongitude>\n      <TrainCode>P508</TrainCode>\n      <TrainDate>04 Nov 2025</TrainDate>\n      <PublicMessage>P508 Cobh to Cork Expected Departure 08:00</PublicMessage>\n      <Direction>To Cork</Direction>\n  </objTrainPositions>\n  <objTrainPositions>\n      <TrainStatus>N</TrainStatus>\n      <TrainLatitude>51.9018</TrainLatitude>\n      <TrainLongitude>-8.4582</TrainLongitude>\n      <TrainCode>D507</TrainCode>\n      <TrainDate>04 Nov 2025</TrainDate>\n      <PublicMessage>D507 Cork to Cobh Expected Departure 08:00</PublicMessage>\n      <Direction>To Cobh</Direction>\n  </objTrainPositions>\n</ArrayOfObjTrainPositions>                  "
+                  }
+                }
+              }
+            }
+          },
+          "422": {
+            "$ref": "#/components/responses/HTTP422Response"
+          },
+          "500": {
+            "$ref": "#/components/responses/HTTP500Response"
+          }
+        }
+      }
+    },
+    "/trains/{TrainId}/movements": {
+      "get": {
+        "summary": "Get the movements of a specific train",
+        "description": "Get a list of movements for a given `TrainId` When provided with a date in the format `DD Mon YYYY`, it will return a list of train movements for that date in XML format. Specifically, it will return an array of objTrainMovements objects.",
+        "operationId": "get_train_movements_getTrainMovements_get",
+        "parameters": [
+          {
+            "name": "TrainId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "description": "The ID of the train.",
+              "title": "Trainid"
+            },
+            "description": "The ID of the train."
+          },
+          {
+            "name": "TrainDate",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "description": "The date to be checked (can be past date or today)",
+              "format": "date",
+              "pattern": "^(0?[1-9]|[12][0-9]|3[01])\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s(19|20)\\d{2}$",
+              "title": "Traindate"
+            },
+            "description": "The date to be checked (can be past date or today)"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "List of Train Movement Objects (XML)",
+            "content": {
+              "application/xml": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/objTrainMovements"
+                  },
+                  "xml": {
+                    "name": "ArrayOfObjTrainMovements",
+                    "namespace": "http://api.irishrail.ie/realtime/",
+                    "wrapped": true
+                  }
+                },
+                "examples": {
+                  "trainMovmements": {
+                    "summary": "List of train movements",
+                    "value": "<ArrayOfObjTrainMovements xmlns=\"http://api.irishrail.ie/realtime/\">\n  <objTrainMovements>\n      <TrainCode>E109 </TrainCode>\n      <TrainDate>11 Dec 2011</TrainDate>\n      <LocationCode>MHIDE</LocationCode>\n      <LocationFullName>Malahide</LocationFullName>\n      <LocationOrder>1</LocationOrder>\n      <LocationType>O</LocationType>\n      <TrainOrigin>Malahide</TrainOrigin>\n      <TrainDestination>Greystones</TrainDestination>\n      <ScheduledArrival>00:00:00</ScheduledArrival>\n      <ScheduledDeparture>18:05:00</ScheduledDeparture>\n      <ExpectedArrival>00:00:00</ExpectedArrival>\n      <ExpectedDeparture>18:05:00</ExpectedDeparture>\n      <Arrival>17:52:36</Arrival>\n      <Departure>18:05:54</Departure>\n      <AutoArrival>1</AutoArrival>\n      <AutoDepart>1</AutoDepart>\n      <StopType>-</StopType>\n  </objTrainMovements>\n  <objTrainMovements>\n      <TrainCode>E109 </TrainCode>\n      <TrainDate>11 Dec 2011</TrainDate>\n      <LocationCode>PMNCK</LocationCode>\n      <LocationFullName>Portmarnock</LocationFullName>\n      <LocationOrder>2</LocationOrder>\n      <LocationType>S</LocationType>\n      <TrainOrigin>Malahide</TrainOrigin>\n      <TrainDestination>Greystones</TrainDestination>\n      <ScheduledArrival>18:08:30</ScheduledArrival>\n      <ScheduledDeparture>18:09:00</ScheduledDeparture>\n      <ExpectedArrival>18:09:24</ExpectedArrival>\n      <ExpectedDeparture>18:09:30</ExpectedDeparture>\n      <Arrival>18:09:00</Arrival>\n      <Departure>18:10:36</Departure>\n      <AutoArrival>1</AutoArrival>\n      <AutoDepart>1</AutoDepart>\n      <StopType>-</StopType>\n  </objTrainMovements>\n</ArrayOfObjTrainMovements>                  "
+                  }
+                }
+              }
+            }
+          },
+          "422": {
+            "$ref": "#/components/responses/HTTP422Response"
+          },
+          "500": {
+            "$ref": "#/components/responses/HTTP500Response"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "HTTPValidationError": {
+        "properties": {
+          "detail": {
+            "items": {
+              "$ref": "#/components/schemas/ValidationError"
+            },
+            "type": "array",
+            "title": "Detail"
+          }
+        },
+        "type": "object",
+        "title": "HTTPValidationError"
+      },
+      "ValidationError": {
+        "properties": {
+          "loc": {
+            "items": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "integer"
+                }
+              ]
+            },
+            "type": "array",
+            "title": "Location"
+          },
+          "msg": {
+            "type": "string",
+            "title": "Message"
+          },
+          "type": {
+            "type": "string",
+            "title": "Error Type"
+          }
+        },
+        "type": "object",
+        "required": [
+          "loc",
+          "msg",
+          "type"
+        ],
+        "title": "ValidationError"
+      },
+      "objStation": {
+        "xml": {
+          "name": "objStation"
+        },
+        "properties": {
+          "StationDesc": {
+            "type": "string",
+            "title": "Stationdesc",
+            "description": "The name of the station"
+          },
+          "StationAlias": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Stationalias"
+          },
+          "StationLatitude": {
+            "type": "number",
+            "title": "Stationlatitude",
+            "description": "The latitude of the station"
+          },
+          "StationLongitude": {
+            "type": "number",
+            "title": "Stationlongitude",
+            "description": "The longitude of the station"
+          },
+          "StationCode": {
+            "type": "string",
+            "title": "Stationcode",
+            "description": "The station code"
+          },
+          "StationId": {
+            "type": "integer",
+            "title": "Stationid",
+            "description": "The station ID"
+          }
+        },
+        "type": "object",
+        "required": [
+          "StationDesc",
+          "StationLatitude",
+          "StationLongitude",
+          "StationCode",
+          "StationId"
+        ],
+        "title": "objStation"
+      },
+      "objStationData": {
+        "xml": {
+          "name": "objStationData"
+        },
+        "properties": {
+          "ServerTime": {
+            "type": "string",
+            "title": "Servertime",
+            "description": "Time on the server"
+          },
+          "TrainCode": {
+            "type": "string",
+            "title": "Traincode",
+            "description": "Unique Id for the train"
+          },
+          "StationFullName": {
+            "type": "string",
+            "title": "Stationfullname",
+            "description": "Long version of Station Name"
+          },
+          "StationCode": {
+            "type": "string",
+            "title": "Stationcode",
+            "description": "4-5 letter station abbreviation"
+          },
+          "QueryTime": {
+            "type": "string",
+            "title": "Querytime",
+            "description": "Time the query was made"
+          },
+          "TrainDate": {
+            "type": "string",
+            "title": "Traindate",
+            "description": "Service start date in the format DD Mon YYYY"
+          },
+          "Origin": {
+            "type": "string",
+            "title": "Origin",
+            "description": "Starting station"
+          },
+          "Destination": {
+            "type": "string",
+            "title": "Destination",
+            "description": "Final station"
+          },
+          "OriginTime": {
+            "type": "string",
+            "title": "Origintime",
+            "description": "Departure time from origin"
+          },
+          "DestinationTime": {
+            "type": "string",
+            "title": "Destinationtime",
+            "description": "Scheduled arrival at destination"
+          },
+          "Status": {
+            "type": "string",
+            "title": "Status",
+            "description": "Latest service information"
+          },
+          "LastLocation": {
+            "type": "string",
+            "title": "Lastlocation",
+            "description": "Format: Arrived|Departed StationName"
+          },
+          "DueIn": {
+            "type": "integer",
+            "title": "Duein",
+            "description": "Minutes until arrival"
+          },
+          "Late": {
+            "type": "integer",
+            "title": "Late",
+            "description": "Minutes delayed"
+          },
+          "ExpArrival": {
+            "type": "string",
+            "title": "Exparrival",
+            "description": "Expected arrival time. Note: Will show 00:00 for trains starting from query station"
+          },
+          "ExpDepart": {
+            "type": "string",
+            "title": "Expdepart",
+            "description": "Expected departure time. Note: Will show 00:00 for trains terminating at query station"
+          },
+          "SchArrival": {
+            "type": "string",
+            "title": "Scharrival",
+            "description": "Scheduled arrival time. Note: Will show 00:00 for trains starting from query station"
+          },
+          "SchDepart": {
+            "type": "string",
+            "title": "Schdepart",
+            "description": "Scheduled departure time. Note: Will show 00:00 for trains terminating at query station"
+          },
+          "Direction": {
+            "type": "string",
+            "title": "Direction",
+            "description": "Northbound, Southbound, or To Destination"
+          },
+          "TrainType": {
+            "type": "string",
+            "title": "Traintype",
+            "description": "DART, Intercity, etc."
+          },
+          "LocationType": {
+            "type": "string",
+            "title": "Locationtype",
+            "description": "O=Origin, D=Destination, S=Stop"
+          }
+        },
+        "type": "object",
+        "required": [
+          "ServerTime",
+          "TrainCode",
+          "StationFullName",
+          "StationCode",
+          "QueryTime",
+          "TrainDate",
+          "Origin",
+          "Destination",
+          "OriginTime",
+          "DestinationTime",
+          "Status",
+          "LastLocation",
+          "DueIn",
+          "Late",
+          "ExpArrival",
+          "ExpDepart",
+          "SchArrival",
+          "SchDepart",
+          "Direction",
+          "TrainType",
+          "LocationType"
+        ],
+        "title": "objStationData"
+      },
+      "objStationFilter": {
+        "xml": {
+          "name": "objStationFilter"
+        },
+        "properties": {
+          "StationDesc_sp": {
+            "type": "string",
+            "title": "Stationdesc Sp",
+            "description": "A special description of the station. May just be the name with some special characters included."
+          },
+          "StationDesc": {
+            "type": "string",
+            "title": "Stationdesc",
+            "description": "The name of the station"
+          },
+          "StationCode": {
+            "type": "string",
+            "title": "Stationcode",
+            "description": "The station code"
+          }
+        },
+        "type": "object",
+        "required": [
+          "StationDesc_sp",
+          "StationDesc",
+          "StationCode"
+        ],
+        "title": "objStationFilter"
+      },
+      "objTrainMovements": {
+        "xml": {
+          "name": "objTrainMovements"
+        },
+        "properties": {
+          "TrainCode": {
+            "type": "string",
+            "title": "Traincode",
+            "description": "Unique Id for the train"
+          },
+          "TrainDate": {
+            "type": "string",
+            "title": "Traindate",
+            "description": "Service start date in the format DD Mon YYYY"
+          },
+          "LocationCode": {
+            "type": "string",
+            "title": "Locationcode",
+            "description": "4-5 letter location abbreviation"
+          },
+          "LocationFullName": {
+            "type": "string",
+            "title": "Locationfullname",
+            "description": "Long version of location name"
+          },
+          "LocationOrder": {
+            "type": "integer",
+            "title": "Locationorder",
+            "description": "The stop order of the location"
+          },
+          "LocationType": {
+            "type": "string",
+            "title": "Locationtype",
+            "description": "Type of location (O=Origin S=Stop T=TimingPoint D=Destination)"
+          },
+          "TrainOrigin": {
+            "type": "string",
+            "title": "Trainorigin",
+            "description": "Starting station"
+          },
+          "TrainDestination": {
+            "type": "string",
+            "title": "Traindestination",
+            "description": "Final station"
+          },
+          "ScheduledArrival": {
+            "type": "string",
+            "title": "Scheduledarrival",
+            "description": "Scheduled arrival time. Note: Will show 00:00 for trains starting from query station"
+          },
+          "ScheduledDeparture": {
+            "type": "string",
+            "title": "Scheduleddeparture",
+            "description": "Scheduled departure time. Note: Will show 00:00 for trains terminating at query station"
+          },
+          "ExpectedArrival": {
+            "type": "string",
+            "title": "Expectedarrival",
+            "description": "Expected arrival time. Note: Will show 00:00 for trains starting from query station"
+          },
+          "ExpectedDeparture": {
+            "type": "string",
+            "title": "Expecteddeparture",
+            "description": "Expected departure time. Note: Will show 00:00 for trains terminating at query station"
+          },
+          "Arrival": {
+            "type": "string",
+            "title": "Arrival",
+            "description": "Actual arrival time"
+          },
+          "Departure": {
+            "type": "string",
+            "title": "Departure",
+            "description": "Actual departure time"
+          },
+          "AutoArrival": {
+            "type": "integer",
+            "title": "Autoarrival",
+            "description": "Was information automatically generated"
+          },
+          "AutoDeparture": {
+            "type": "integer",
+            "title": "Autodeparture",
+            "description": "Was information automatically generated"
+          },
+          "StopType": {
+            "type": "string",
+            "title": "Stoptype",
+            "description": "Stop Type (C=Current N=Next"
+          }
+        },
+        "type": "object",
+        "required": [
+          "TrainCode",
+          "TrainDate",
+          "LocationCode",
+          "LocationFullName",
+          "LocationOrder",
+          "LocationType",
+          "TrainOrigin",
+          "TrainDestination",
+          "ScheduledArrival",
+          "ScheduledDeparture",
+          "ExpectedArrival",
+          "ExpectedDeparture",
+          "Arrival",
+          "Departure",
+          "AutoArrival",
+          "AutoDeparture",
+          "StopType"
+        ],
+        "title": "objTrainMovements"
+      },
+      "objTrainPositions": {
+        "xml": {
+          "name": "objTrainPositions"
+        },
+        "properties": {
+          "TrainStatus": {
+            "type": "string",
+            "title": "Trainstatus",
+            "description": "Status of the train (N = Not yet running R = Running)"
+          },
+          "TrainLatitude": {
+            "type": "number",
+            "title": "Trainlatitude",
+            "description": "Latitude of the train"
+          },
+          "TrainLongitude": {
+            "type": "number",
+            "title": "Trainlongitude",
+            "description": "Longitude of the train"
+          },
+          "TrainCode": {
+            "type": "string",
+            "title": "Traincode",
+            "description": "The train code"
+          },
+          "TrainDate": {
+            "type": "string",
+            "title": "Traindate",
+            "description": "The date of the train in the format DD Mon YYYY"
+          },
+          "PublicMessage": {
+            "type": "string",
+            "title": "Publicmessage",
+            "description": "Public message to be displayed (i.e AA509\n11:00 - Waterford to Dublin (0 mins late)\nDeparted Waterford next stop Thomastown)"
+          },
+          "Direction": {
+            "type": "string",
+            "title": "Direction",
+            "description": "Direction of the train (Northbound/Southbound between Dundalk and Rosslare and between Dublin and Sligo, for all other locations it is the destination e.g To Cork"
+          }
+        },
+        "type": "object",
+        "required": [
+          "TrainStatus",
+          "TrainLatitude",
+          "TrainLongitude",
+          "TrainCode",
+          "TrainDate",
+          "PublicMessage",
+          "Direction"
+        ],
+        "title": "objTrainPositions"
+      }
+    },
+    "responses": {
+      "HTTP422Response": {
+        "description": "Validation Error",
+        "content": {
+          "application/xml": {
+            "schema": {
+              "$ref": "#/components/schemas/HTTPValidationError",
+              "xml": {
+                "name": "Error",
+                "namespace": "http://api.irishrail.ie/realtime/"
+              }
+            }
+          },
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/HTTPValidationError"
+            }
+          }
+        }
+      },
+      "HTTP500Response": {
+        "description": "Internal Server Error (XML)",
+        "content": {
+          "application/xml": {
+            "schema": {
+              "type": "object",
+              "xml": {
+                "name": "Error",
+                "namespace": "http://api.irishrail.ie/realtime/"
+              },
+              "properties": {
+                "message": {
+                  "type": "string"
+                },
+                "details": {
+                  "type": "string"
+                }
+              }
+            },
+            "examples": {
+              "serverError": {
+                "summary": "Example error response",
+                "value": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<Error>\n    <Message>Failed to retrieve station data</Message>\n    <Details>Unable to reach server</Details>\n</Error>"
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
+

jentic_openapi_validator_spectral-1.0.0a16/src/jentic/apitools/openapi/validator/backends/spectral/rulesets/spectral.mjs

@@ -0,0 +1,78 @@
+import { oas3 } from '@stoplight/spectral-formats';
+import { oasExample } from '@stoplight/spectral-rulesets/dist/oas/functions/index.js';
+import oasRuleset from '@stoplight/spectral-rulesets/dist/oas/index.js';
+
+// Custom wrapper around oasExample that skips XML-related examples
+const oasExampleNonXml = (targetVal, opts, context) => {
+  const path = context.path || [];
+  const pathString = path.join('.');
+
+  // Case 1: Media Type Objects - filter by media type in path
+  // Path format: paths./station-timetables.get.responses[200].content.application/xml.examples
+  // Matches patterns like: .content.application/xml. or .content.image/svg+xml.
+  if (pathString.match(/\.content\.[^.]*(\/xml|\+xml)\b/i)) {
+    return [];
+  }
+
+  // Case 2 & 3: Header/Parameter Objects - check if their schema has xml property
+  // Path format: paths./stations.get.parameters[0].schema or paths./.headers.X-Custom.schema
+  // The targetVal is the object with schema and example/examples
+  if (targetVal && targetVal.schema && targetVal.schema.xml) {
+    return [];
+  }
+
+  // Otherwise, delegate to the original oasExample function
+  return oasExample(targetVal, opts, context);
+};
+
+export default {
+  extends: [oasRuleset],
+  rules: {
+    'oas3-schema': 'error',
+
+    // --- MEDIA EXAMPLES ---
+    // Override to skip XML media type validation using custom wrapper function
+    'oas3-valid-media-example': {
+      description: 'Examples must be valid against their defined schema (non-XML media only).',
+      message: '{{error}}',
+      severity: 'error',
+      formats: [oas3],
+      given: [
+        '$..content..[?(@ && @.schema && (@.example !== void 0 || @.examples))]',
+        '$..headers..[?(@ && @.schema && (@.example !== void 0 || @.examples))]',
+        '$..parameters..[?(@ && @.schema && (@.example !== void 0 || @.examples))]',
+      ],
+      then: {
+        function: oasExampleNonXml,
+        functionOptions: {
+          schemaField: 'schema',
+          oasVersion: 3,
+          type: 'media'
+        }
+      }
+    },
+
+    // --- SCHEMA EXAMPLES ---
+    // Override to skip schemas that have an xml property at the top level
+    'oas3-valid-schema-example': {
+      description: 'Examples must be valid against their defined schema (skip schemas that declare XML mapping).',
+      message: '{{error}}',
+      severity: 'error',
+      formats: [oas3],
+      given: [
+        '$.components.schemas..[?(@property !== \'properties\' && @ && (@.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items) && !@.xml)]',
+        '$..content..[?(@property !== \'properties\' && @ && (@.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items) && !@.xml)]',
+        '$..headers..[?(@property !== \'properties\' && @ && (@.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items) && !@.xml)]',
+        '$..parameters..[?(@property !== \'properties\' && @ && (@.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items) && !@.xml)]'
+      ],
+      then: {
+        function: oasExample,
+        functionOptions: {
+          schemaField: '$',
+          oasVersion: 3,
+          type: 'schema'
+        }
+      }
+    }
+  }
+};

jentic_openapi_validator_spectral-1.0.0a14/src/jentic/apitools/openapi/validator/backends/spectral/rulesets/spectral.yaml

@@ -1,3 +0,0 @@
-extends: spectral:oas
-rules:
-  oas3-schema: error