Skip to content

Commit

Permalink
Improve docs; add skeleton tests
Browse files Browse the repository at this point in the history
  • Loading branch information
ianthetechie committed Jul 9, 2024
1 parent 63ca24c commit 2bf4559
Show file tree
Hide file tree
Showing 103 changed files with 420 additions and 2,806 deletions.
193 changes: 0 additions & 193 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -1,105 +1,8 @@
.gitignore
.openapi-generator-ignore
.php-cs-fixer.dist.php
.travis.yml
README.md
composer.json
docs/Api/GeocodingApi.md
docs/Api/GeospatialApi.md
docs/Api/RoutingApi.md
docs/Model/Access.md
docs/Model/AdminRegion.md
docs/Model/Administrative.md
docs/Model/AutoCostingOptions.md
docs/Model/BaseCostingOptions.md
docs/Model/BaseTraceRequest.md
docs/Model/BicycleCostingOptions.md
docs/Model/BikeNetwork.md
docs/Model/Contour.md
docs/Model/Coordinate.md
docs/Model/CostingModel.md
docs/Model/CostingOptions.md
docs/Model/DirectionsOptions.md
docs/Model/DistanceUnit.md
docs/Model/EdgeSign.md
docs/Model/EdgeUse.md
docs/Model/EndNode.md
docs/Model/GeoAttributes.md
docs/Model/GeoJSONGeometry.md
docs/Model/GeoJSONGeometryBase.md
docs/Model/GeoJSONLineString.md
docs/Model/GeoJSONPoint.md
docs/Model/GeoJSONPolygon.md
docs/Model/GeocodingObject.md
docs/Model/HeightRequest.md
docs/Model/HeightResponse.md
docs/Model/HighwayClassification.md
docs/Model/IntersectingEdge.md
docs/Model/IsochroneCostingModel.md
docs/Model/IsochroneFeature.md
docs/Model/IsochroneProperties.md
docs/Model/IsochroneRequest.md
docs/Model/IsochroneResponse.md
docs/Model/LocateDetailedEdge.md
docs/Model/LocateEdge.md
docs/Model/LocateEdgeInfo.md
docs/Model/LocateNode.md
docs/Model/LocateObject.md
docs/Model/LowSpeedVehicleCostingOptions.md
docs/Model/ManeuverSign.md
docs/Model/ManeuverSignElement.md
docs/Model/MapMatchCostingModel.md
docs/Model/MapMatchRequest.md
docs/Model/MapMatchRouteResponse.md
docs/Model/MapMatchTraceOptions.md
docs/Model/MapMatchWaypoint.md
docs/Model/MatchedPoint.md
docs/Model/MatrixCostingModel.md
docs/Model/MatrixDistance.md
docs/Model/MatrixRequest.md
docs/Model/MatrixResponse.md
docs/Model/MatrixWaypoint.md
docs/Model/MotorScooterCostingOptions.md
docs/Model/MotorcycleCostingOptions.md
docs/Model/NearestRoadsRequest.md
docs/Model/NodeId.md
docs/Model/NodeType.md
docs/Model/OptimizedRouteRequest.md
docs/Model/PedestrianCostingOptions.md
docs/Model/PeliasGeoJSONFeature.md
docs/Model/PeliasGeoJSONProperties.md
docs/Model/PeliasGeoJSONPropertiesAddendum.md
docs/Model/PeliasGeoJSONPropertiesAddendumOsm.md
docs/Model/PeliasLayer.md
docs/Model/PeliasResponse.md
docs/Model/PeliasSource.md
docs/Model/Restrictions.md
docs/Model/RoadClass.md
docs/Model/RouteLeg.md
docs/Model/RouteManeuver.md
docs/Model/RouteRequest.md
docs/Model/RouteResponse.md
docs/Model/RouteResponseAlternatesInner.md
docs/Model/RouteSummary.md
docs/Model/RouteTrip.md
docs/Model/RoutingResponseWaypoint.md
docs/Model/RoutingWaypoint.md
docs/Model/RoutingWaypointAllOfSearchFilter.md
docs/Model/SimpleRoutingWaypoint.md
docs/Model/Speeds.md
docs/Model/TraceAttributeFilterOptions.md
docs/Model/TraceAttributeKey.md
docs/Model/TraceAttributesBaseResponse.md
docs/Model/TraceAttributesRequest.md
docs/Model/TraceAttributesResponse.md
docs/Model/TraceEdge.md
docs/Model/TravelMode.md
docs/Model/Traversability.md
docs/Model/TruckCostingOptions.md
docs/Model/TzResponse.md
docs/Model/ValhallaLanguages.md
docs/Model/ValhallaLongUnits.md
docs/Model/Warning.md
git_push.sh
lib/Api/GeocodingApi.php
lib/Api/GeospatialApi.php
Expand Down Expand Up @@ -203,99 +106,3 @@ lib/Model/ValhallaLongUnits.php
lib/Model/Warning.php
lib/ObjectSerializer.php
phpunit.xml.dist
test/Api/GeocodingApiTest.php
test/Api/GeospatialApiTest.php
test/Api/RoutingApiTest.php
test/Model/AccessTest.php
test/Model/AdminRegionTest.php
test/Model/AdministrativeTest.php
test/Model/AutoCostingOptionsTest.php
test/Model/BaseCostingOptionsTest.php
test/Model/BaseTraceRequestTest.php
test/Model/BicycleCostingOptionsTest.php
test/Model/BikeNetworkTest.php
test/Model/ContourTest.php
test/Model/CoordinateTest.php
test/Model/CostingModelTest.php
test/Model/CostingOptionsTest.php
test/Model/DirectionsOptionsTest.php
test/Model/DistanceUnitTest.php
test/Model/EdgeSignTest.php
test/Model/EdgeUseTest.php
test/Model/EndNodeTest.php
test/Model/GeoAttributesTest.php
test/Model/GeoJSONGeometryBaseTest.php
test/Model/GeoJSONGeometryTest.php
test/Model/GeoJSONLineStringTest.php
test/Model/GeoJSONPointTest.php
test/Model/GeoJSONPolygonTest.php
test/Model/GeocodingObjectTest.php
test/Model/HeightRequestTest.php
test/Model/HeightResponseTest.php
test/Model/HighwayClassificationTest.php
test/Model/IntersectingEdgeTest.php
test/Model/IsochroneCostingModelTest.php
test/Model/IsochroneFeatureTest.php
test/Model/IsochronePropertiesTest.php
test/Model/IsochroneRequestTest.php
test/Model/IsochroneResponseTest.php
test/Model/LocateDetailedEdgeTest.php
test/Model/LocateEdgeInfoTest.php
test/Model/LocateEdgeTest.php
test/Model/LocateNodeTest.php
test/Model/LocateObjectTest.php
test/Model/LowSpeedVehicleCostingOptionsTest.php
test/Model/ManeuverSignElementTest.php
test/Model/ManeuverSignTest.php
test/Model/MapMatchCostingModelTest.php
test/Model/MapMatchRequestTest.php
test/Model/MapMatchRouteResponseTest.php
test/Model/MapMatchTraceOptionsTest.php
test/Model/MapMatchWaypointTest.php
test/Model/MatchedPointTest.php
test/Model/MatrixCostingModelTest.php
test/Model/MatrixDistanceTest.php
test/Model/MatrixRequestTest.php
test/Model/MatrixResponseTest.php
test/Model/MatrixWaypointTest.php
test/Model/MotorScooterCostingOptionsTest.php
test/Model/MotorcycleCostingOptionsTest.php
test/Model/NearestRoadsRequestTest.php
test/Model/NodeIdTest.php
test/Model/NodeTypeTest.php
test/Model/OptimizedRouteRequestTest.php
test/Model/PedestrianCostingOptionsTest.php
test/Model/PeliasGeoJSONFeatureTest.php
test/Model/PeliasGeoJSONPropertiesAddendumOsmTest.php
test/Model/PeliasGeoJSONPropertiesAddendumTest.php
test/Model/PeliasGeoJSONPropertiesTest.php
test/Model/PeliasLayerTest.php
test/Model/PeliasResponseTest.php
test/Model/PeliasSourceTest.php
test/Model/RestrictionsTest.php
test/Model/RoadClassTest.php
test/Model/RouteLegTest.php
test/Model/RouteManeuverTest.php
test/Model/RouteRequestTest.php
test/Model/RouteResponseAlternatesInnerTest.php
test/Model/RouteResponseTest.php
test/Model/RouteSummaryTest.php
test/Model/RouteTripTest.php
test/Model/RoutingResponseWaypointTest.php
test/Model/RoutingWaypointAllOfSearchFilterTest.php
test/Model/RoutingWaypointTest.php
test/Model/SimpleRoutingWaypointTest.php
test/Model/SpeedsTest.php
test/Model/TraceAttributeFilterOptionsTest.php
test/Model/TraceAttributeKeyTest.php
test/Model/TraceAttributesBaseResponseTest.php
test/Model/TraceAttributesRequestTest.php
test/Model/TraceAttributesResponseTest.php
test/Model/TraceEdgeTest.php
test/Model/TravelModeTest.php
test/Model/TraversabilityTest.php
test/Model/TruckCostingOptionsTest.php
test/Model/TzResponseTest.php
test/Model/ValhallaLanguagesTest.php
test/Model/ValhallaLongUnitsTest.php
test/Model/WarningTest.php
7 changes: 5 additions & 2 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,15 @@ Regenerating the generated portions of the codebase can be done simply with this
(run this whenever new features / changes to the OpenAPI spec are released).

```shell
openapi-generator generate -i https://api.stadiamaps.com/openapi.yaml -g php --strict-spec=true -o . -p disallowAdditionalPropertiesIfNotPresent=false -p composerPackageName="stadiamaps/api"
openapi-generator generate -i https://api.stadiamaps.com/openapi.yaml -g php --strict-spec=true -o . -p disallowAdditionalPropertiesIfNotPresent=false -p composerPackageName="stadiamaps/api" --global-property apiDocs=false,modelTests=false,modelDocs=false
```

## Tests

TODO
```bash
composer install
vendor/bin/phpunit
```

## Release

Expand Down
Loading

0 comments on commit 2bf4559

Please sign in to comment.