Merge pull request #1487 from UnionInternationalCheminsdeFer/deprecate-trips-collection-singular

Deprecate POST /trips-collection in favor of new POST /trips-collections

Author: CGantert345

specification/OSDM-online-api.yml

@@ -126,6 +126,8 @@ paths:
     $ref: ./paths/places.yml#/~1places~1{placeId}
   /trips-collection:
     $ref: ./paths/trips.yml#/~1trips-collection
+  /trips-collections:
+    $ref: ./paths/trips.yml#/~1trips-collections
   /trips-collections/{tripsCollectionId}:
     $ref: ./paths/trips.yml#/~1trips-collections~1{tripsCollectionId}
   /trips:

specification/paths/trips.yml

@@ -5,7 +5,68 @@
     summary: returns a collection of trips for a given OJP trip request
     description: |
       Returns trips for a given trip request based on the OJP specification.
+
+      Deprecated: use `POST /trips-collections` (plural) instead. This path will be removed in 4.0.0.
     operationId: postTrips
+    deprecated: true
+    parameters:
+    - $ref: ../OSDM-online-api.yml#/components/parameters/requestor
+    - $ref: ../OSDM-online-api.yml#/components/parameters/acceptLanguage
+    - $ref: ../OSDM-online-api.yml#/components/parameters/traceParent
+    - $ref: ../OSDM-online-api.yml#/components/parameters/traceState
+    - $ref: ../OSDM-online-api.yml#/components/parameters/acceptNamespace
+    - $ref: ../OSDM-online-api.yml#/components/parameters/page
+    - name: stopBehavior
+      in: query
+      schema:
+        $ref: ../OSDM-online-api.yml#/components/schemas/StopBehavior
+      required: false
+    requestBody:
+      required: true
+      description: |
+        request for trips
+      content:
+        application/json:
+          schema:
+            $ref: ../OSDM-online-api.yml#/components/schemas/TripSearchCriteria
+    responses:
+      '200':
+        description: |
+          trips found
+        content:
+          application/json:
+            schema:
+              $ref: ../OSDM-online-api.yml#/components/schemas/TripCollectionResponse
+      '400':
+        $ref: ../OSDM-online-api.yml#/components/responses/BadRequestResponse
+      '401':
+        $ref: ../OSDM-online-api.yml#/components/responses/UnauthorizedResponse
+      '403':
+        $ref: ../OSDM-online-api.yml#/components/responses/ForbiddenResponse
+      '404':
+        $ref: ../OSDM-online-api.yml#/components/responses/NotFoundResponse
+      '406':
+        $ref: ../OSDM-online-api.yml#/components/responses/NotAcceptableResponse
+      '415':
+        $ref: ../OSDM-online-api.yml#/components/responses/UnsupportedMediaTypeResponse
+      '500':
+        $ref: ../OSDM-online-api.yml#/components/responses/InternalServerErrorResponse
+      '501':
+        $ref: ../OSDM-online-api.yml#/components/responses/NotImplementedResponse
+      '503':
+        $ref: ../OSDM-online-api.yml#/components/responses/ServiceUnavailableResponse
+      default:
+        $ref: ../OSDM-online-api.yml#/components/responses/DefaultErrorResponse
+/trips-collections:
+  post:
+    tags:
+    - Trips
+    summary: returns a collection of trips for a given OJP trip request
+    description: |
+      Returns trips for a given trip request based on the OJP specification.
+
+      Replaces the deprecated `POST /trips-collection` (singular).
+    operationId: postTripsCollection
     parameters:
     - $ref: ../OSDM-online-api.yml#/components/parameters/requestor
     - $ref: ../OSDM-online-api.yml#/components/parameters/acceptLanguage