Release 0.5.0 - Clara by edwinvandenbelt · Pull Request #145 · TOMP-WG/TOMP-API

edwinvandenbelt · 2020-04-29T07:13:34Z

Breaking release. Instead of kebab-cased json, we now use camelCased json. Also other breaking issues. Look at the release notes in wiki

Fix issue TOMP-WG#95

# Conflicts: # TOMP-API.yaml

TOMP-WG#114 remove asset, is included in typeOfAsset TOMP-WG#110 consistency in Operator Information

Changed systemInformation from array to single object Change openingTimes to returnTimes Fix condition inheritance Reference: https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/ Remove duplicate customer requirements Replace kebab-case with camelCase Add missing TO tags Remove station_status fields from stationInformation Remove duplicate area definition, clarify area usage Remove gender (should be in asset (type) if anywhere) Fix allOf and oneOf syntax Use built-in date format Fix response codes Alphabetise sections

Develop major

Amendments to Edwin's PR

Tjalle

Hello Edwin,

I've gone over this document & the changes and added some comments.

hope this helps,

Tjalle

Tjalle · 2020-05-04T07:46:23Z

TOMP-API.yaml

          headers:
            Location:
-              description: The URI where the created options can be found, in case of 'provide-ids' = true
+              description: The URI where the created options can be found, in case of 'provideIds' = true
              schema:
                type: string
                example: '/planning-options/1234'


/planningOptions/1234 -> camelCase

Tjalle, we agreed on kebab-casing the URLs.

ok, my bad.

Tjalle · 2020-05-04T07:47:56Z

TOMP-API.yaml

        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '404':
          $ref: '#/components/responses/404NotFound'
+        '410':
+          $ref: '#/components/responses/410Gone'
      callbacks:   # webhooks
        # as described in https://swagger.io/docs/specification/callbacks/
        booking-operations:


bookingOperations

not a issue -> url

Tjalle · 2020-05-04T07:48:40Z

TOMP-API.yaml

+        '410':
+          $ref: '#/components/responses/410Gone'
+
+  /legs/{id}/available-assets:


availableAssets

Tjalle · 2020-05-04T07:52:08Z

TOMP-API.yaml

-               
-  /operator/pricing-plans:
+
+  /operator/available-assets:


availableAssets

not a issue -> url

Tjalle · 2020-05-04T07:53:09Z

TOMP-API.yaml

+        '401':
+          $ref: '#/components/responses/401Unauthorized'
+
+  /operator/pricing-plans:


pricingPlans

not a issue -> url

Tjalle · 2020-05-04T08:04:38Z

TOMP-API.yaml

      type: object
      description: provides current asset location & duration and distance of the current leg
      required:
-        - coordinates
+        - coordinate


coordinate is a req. field, but in the properties below it's still coordinates

Check, I'll repair this one

Tjalle · 2020-05-04T08:05:24Z

TOMP-API.yaml

+
+    license:
+      type: object
+      description: driver or usage license for a specific user. Contains the number and the asset-type you're allowed to operate (e.g. driver license for CAR)


and the assetType you're allowed

yes. repaired

Tjalle · 2020-05-04T08:07:54Z

TOMP-API.yaml

+              description: the amount of people that have to travel from `from` to `to` [https://github.com/efel85/TOMP-API/issues/56]
+              type: number
+            useAssets:
+              description: when you use the /operator/available-assets and you want to book a displayed asset, you must be able to request o a planning-option for the specific asset (with provide-ids=true), post a booking with the provided id and send directly a commit. This field should contain the asset to book.


when you use the /operator/availableAssets

not a issue -> url

Tjalle · 2020-05-04T08:09:15Z

TOMP-API.yaml

+      required:
+        - stationId
+        - name
+        - coordinate


required/properties-> coordinate vs coordinates

Tjalle · 2020-05-04T08:12:09Z

TOMP-API.yaml

kebab case => camelCase was only for the JSON.

ARBaart and others added 14 commits March 10, 2020 15:27

Replace coordinate with coordinates

687166c

Fix issue TOMP-WG#95

TOMP-WG#120 composit-leg should be composite-leg

12e00e4

Update TOMP-API.yaml

5422a36

Update TOMP-API.yaml

b225627

Merge remote-tracking branch 'upstream/develop-major' into develop-major

92fbb4e

Merge branch 'develop-minor' into develop-major

24f1a86

# Conflicts: # TOMP-API.yaml

Breaking issues

49edbf9

TOMP-WG#114 remove asset, is included in typeOfAsset TOMP-WG#110 consistency in Operator Information

hotfix for keyValue object

52a1529

Merge pull request TOMP-WG#123 from edwinvandenbelt/develop-major

d794ad0

Develop major

Merge pull request TOMP-WG#139 from Threore/various-fixes

c9080ca

Amendments to Edwin's PR

Generatable swagger

6afd550

Merge branch 'master' into release-0.5.0

9fa87b8

last minute hotfix for keyvalue pair

16c8e5e

Tjalle reviewed May 4, 2020

View reviewed changes

Release 0.5.0

4db8983

edwinvandenbelt merged commit c47693c into TOMP-WG:master May 5, 2020

edwinvandenbelt deleted the release-0.5.0 branch October 7, 2020 06:49

Conversation

edwinvandenbelt commented Apr 29, 2020

Uh oh!

Tjalle left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants