[F] version 3.0.0 - major changes in api #2

mikafinja · 2017-08-07T17:26:36Z

spec for api version 3.0.0

YtvwlD · 2017-09-27T16:27:15Z

spec/swagger.yaml

              price:
                type: integer
                default: 150
+              barcode:
+                type: string
+              image:


How is this supposed to work?
Currently (mete/v1) we are POSTing (or PATCHing) a file called logo along with the other parameters.
(Which isn't documented, yet.)

Edit: Nevermind.

YtvwlD · 2017-09-27T16:28:16Z

spec/swagger.yaml

+        name: start
+        required: true
+        type: string
+        description: start date in ISO8601 format


I really like this. 😃
The date format is currently very ugly.

Yes it's ugly and these parameter arrays are only supported by php and ruby. Afaik no other language is capable of handling these properly.

We could use type: date for this. (see Swagger Spec and RFC 3339)

yes, I'm still learning swagger and when I raised the pull request, I didn't know about it :(

YtvwlD · 2017-09-27T16:30:36Z

spec/swagger.yaml

+          name: id
+          type: integer
+          required: true
+          description: Numeric ID of the user to get.


Well I think an old relic of an idea I had before... Will be removed. Soon™

Oh, I think it was a c'n'p error :(

YtvwlD · 2017-09-27T16:31:05Z

spec/swagger.yaml

+      global_credit_limit:
+        type: integer
+        example: 2000
+        description: globale credit limit in cent; to disable set to false


YtvwlD · 2017-09-27T16:32:04Z

spec/swagger.yaml

      price:
        type: integer
        default: 150
+      barcode:


A product can have multiple barcodes, currently. It would be nice to preserve this.
We used to have endpoints on /barcodes/ for this stuff.
(But this isn't documented in v1, yet.)

okay, I'll rewrite this. It's true. A product may have multiple barcodes during it's lifetime.

If you can wait a few days, the current endpoints under /barcodes in Mete will be in v1.

This might be interesting: https://space-market.github.io/API/preview/v1/#tag/barcodes

YtvwlD · 2017-09-27T16:32:33Z

spec/swagger.yaml

@@ -529,6 +665,8 @@ definitions:
      balance:
        description: in cents
        type: integer
+      barcode:


Why do users have barcodes?

The idea is to implement a kind of 'payment card'. With these you can have smaller devices which only have a small lcd. The user first scans his card, than his credit is shown and afterwards the product is scanned and the transaction is completed.

YtvwlD · 2017-09-27T16:37:45Z

All in all, this looks great. I really like the date format and to option to upload images for users.
Do we want to keep the email field and / or the Gravatar integration?

I don't really know about the barcode stuff. The spec for v1 doesn't include it, but um, that's not your fault.

mikafinja

Hmm, not sure. I would prefere to drop the gravatar service to get rid of any external dependencies. An I think we should keep any data local and not rely on external services. An it's more "datensparsam" :)

mikafinja · 2017-09-28T15:27:46Z

spec/swagger.yaml

+          name: id
+          type: integer
+          required: true
+          description: Numeric ID of the user to get.


Well I think an old relic of an idea I had before... Will be removed. Soon™

mikafinja · 2017-09-28T15:28:10Z

spec/swagger.yaml

+      global_credit_limit:
+        type: integer
+        example: 2000
+        description: globale credit limit in cent; to disable set to false


mikafinja · 2017-09-28T15:29:06Z

spec/swagger.yaml

      price:
        type: integer
        default: 150
+      barcode:


okay, I'll rewrite this. It's true. A product may have multiple barcodes during it's lifetime.

mikafinja · 2017-09-28T15:30:52Z

spec/swagger.yaml

@@ -529,6 +665,8 @@ definitions:
      balance:
        description: in cents
        type: integer
+      barcode:


The idea is to implement a kind of 'payment card'. With these you can have smaller devices which only have a small lcd. The user first scans his card, than his credit is shown and afterwards the product is scanned and the transaction is completed.

YtvwlD · 2017-09-29T19:14:01Z

Transferring amounts between users would probably be nice (see mete#46).

YtvwlD · 2017-09-30T11:58:18Z

I'd like to announce the possible amounts to deposit via the API, too (see mete#5).

…ypos corrected

mikafinja · 2017-10-30T23:16:03Z

Barcodes updated to be compatible with mete, amount of calories and sugar for products added, transfers between users, amounts of deposits are read- and setable via api (denominations)

YtvwlD

Thank you!

YtvwlD · 2017-10-31T15:03:29Z

spec/swagger.yaml

+    patch:
+      tags:
+      - barcodes
+      summary: update an exsisting barcode


YtvwlD · 2017-10-31T15:06:08Z

spec/swagger.yaml

+      - created_at
+      - updated_at
+    properties:
+      id:


Do barcodes need to have an id? The barcode content should be unique, anyway.
(If they don't have one, we won't be able to update a barcode later on. But this might not be needed.)

The barcodes have to be unique, otherwise you won't be able to tell them apart. I tried to maintain an unique way to form the api endpoints. Therefore I decided to assign an id to them.

YtvwlD · 2017-10-31T15:06:33Z

spec/swagger.yaml

+      updated_at:
+        type: string
+        format: date-time
+


A final newline would be nice.

Ummm, there is a final newline…

YtvwlD · 2017-10-31T15:08:15Z

I'm not really decided about whether barcodes should have an id different to their content.
But otherwise, this looks really nice.

@nomaster @marudor Any thoughts on this?

marudor · 2017-11-01T10:05:51Z

Indifferent about Barcods.

mikafinja · 2017-11-06T21:03:53Z

just added a new path to get user's details via an associated barcode. It is required to build small checkout devices with a 'payment card' as discussed above.

YtvwlD · 2018-02-07T18:57:10Z

I would like to keep the attribute bottle_size (or something like this).
And I would like to have defaults for creating new entities.
And if the typo could be corrected, I'm for merging this.

marudor · 2018-04-19T11:14:06Z

I'm all for merging now.

YtvwlD · 2018-04-19T11:18:18Z

Could we make the support for uploading user avatars optional (eg. make the server just return an error message or something like that)?

This would help in implementing this API version in mete, because uploading images could be done later™.

(Clients wishing to support older API versions will have to make this optional, either way.)

marudor · 2018-04-19T12:49:24Z

How about we treat /image as optional (No Idea how to show that in swagge actually) and add a capabilities to /info.json.
If we return something like capabilities: { image: true } server supports /image.
Otherwise not.

mikafinja · 2018-04-20T16:21:50Z

/images is optional. You can query the server if images are supported or not ny sending a get request to /images and it'll return 204 if the server is capable and 501 if the feature isn't implemented (yet).

YtvwlD · 2018-05-25T19:00:41Z

spec/swagger.yaml

@@ -104,9 +90,11 @@ paths:
                      type: integer
                    product:
                      type: integer
+        401:
+          description: Audits deactived by user


mikafinja added 4 commits August 7, 2017 19:24

[F] version 3.0.0 - major changes in api

f4eae09

[B] wrong default version string in server object fixed

2214799

[B] changed image upload spec to match swagger's specifications

e70c40e

[B] fixed image and avatar properties of users / products

ee2952b

YtvwlD reviewed Sep 27, 2017

View reviewed changes

mikafinja commented Sep 28, 2017

View reviewed changes

mikafinja added 2 commits October 30, 2017 23:49

denominations & barcodes added, sugar and calories for products and t…

630f9e2

…ypos corrected

added energy and sugar for products

27fcad9

YtvwlD reviewed Oct 31, 2017

View reviewed changes

Changed response for servers capable of images to 204

4f69ee8

added path to get user`s details via barcode

73f52c2

YtvwlD mentioned this pull request Apr 5, 2018

please add some lines on howto config/admin chaosdorf/mete#61

Closed

mikafinja added 2 commits April 12, 2018 21:19

fixes several typos

83b5c22

adds default values and package size

1411f2b

YtvwlD reviewed May 25, 2018

View reviewed changes

[M] typo fixed

5d93e74

marudor merged commit 99b7584 into Space-Market:master Jun 14, 2018

[F] version 3.0.0 - major changes in api #2

[F] version 3.0.0 - major changes in api #2

Conversation

mikafinja commented Aug 7, 2017

YtvwlD Sep 27, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

YtvwlD Sep 29, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

YtvwlD Sep 27, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

YtvwlD commented Sep 27, 2017

mikafinja left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

YtvwlD commented Sep 29, 2017

YtvwlD commented Sep 30, 2017

mikafinja commented Oct 30, 2017

YtvwlD left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

YtvwlD commented Oct 31, 2017

marudor commented Nov 1, 2017

mikafinja commented Nov 6, 2017

YtvwlD commented Feb 7, 2018

marudor commented Apr 19, 2018

YtvwlD commented Apr 19, 2018 • edited Loading

marudor commented Apr 19, 2018

mikafinja commented Apr 20, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

YtvwlD Sep 27, 2017 •

edited

Loading

YtvwlD Sep 29, 2017 •

edited

Loading

YtvwlD Sep 27, 2017 •

edited

Loading

YtvwlD commented Apr 19, 2018 •

edited

Loading