lcdp-api 1.12.27__tar.gz

lcdp_api-1.12.27/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright (c) 2019 Le Comptoir Des Pharmarcies
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

lcdp_api-1.12.27/MANIFEST.in

@@ -0,0 +1,2 @@
+graft event
+graft rest

lcdp_api-1.12.27/PKG-INFO

@@ -0,0 +1,14 @@
+Metadata-Version: 2.1
+Name: lcdp_api
+Version: 1.12.27
+Summary: Rest api specification for Le Comptoir Des Pharmacies
+Home-page: https://bitbucket.org/lecomptoirdespharmacies/lcdp-api
+Author: Le Comptoir Des Pharmacies
+Author-email: g.thrasibule@lecomptoirdespharmacies.fr
+License: Apache-2.0
+Keywords: openapi,rest-api,rest,openapi3
+Platform: UNKNOWN
+License-File: LICENSE.md
+
+Rest api specification for Le Comptoir Des Pharmacies
+

lcdp_api-1.12.27/README.md

@@ -0,0 +1,19 @@
+### LCDP api
+
+## Présentation
+Ce dépôt contient les définitions **open API 3.0** de l'API Rest LCDP
+
+[Open API 3.0 Doc](https://swagger.io/specification/)
+
+##  Docker
+
+Un docker-compose permettant de lancer swagger-ui est en place dans le dossier
+`swagger-ui/docker-compose.yml`
+
+## Exécuter les requêtes swagger en local
+
+Si la stack LCDP tourne en local, le swagger-ui ne pourra pas effectuer de requête vers la stack local à cause des CORS.
+
+Pour permettre au swagger-ui d'exécuter les requêtes, if faut l'ouvrir dans **un navigateur non sécurisé**.
+ 
+Voir : [Documentation Utiliser swagger sans CORS](https://lecomptoirdespharmacies.atlassian.net/wiki/spaces/LCDP/pages/87261185/Utiliser+Swagger+UI+sans+CORS)

lcdp_api-1.12.27/event/configuration/Variable/Key.avsc

@@ -0,0 +1,15 @@
+{
+  "namespace": "configuration",
+  "type": "record",
+  "name": "VariableKey",
+  "fields": [
+    {
+      "name": "id",
+      "type": [
+        "null",
+        "string"
+      ],
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/configuration/Variable/Value.avsc

@@ -0,0 +1,23 @@
+{
+  "namespace": "configuration",
+  "type": "record",
+  "name": "VariableValue",
+  "fields": [
+    {
+      "name": "id",
+      "type": [
+        "null",
+        "string"
+      ],
+      "default": null
+    },
+    {
+      "name": "value",
+      "type": [
+        "null",
+        "string"
+      ],
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/favorite/FavoriteProduct/Key.avsc

@@ -0,0 +1,15 @@
+{
+  "namespace": "favorite",
+  "type": "record",
+  "name": "FavoriteProductKey",
+  "fields": [
+    {
+      "name": "id",
+      "type": [
+        "null",
+        "long"
+      ],
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/favorite/FavoriteProduct/Value.avsc

@@ -0,0 +1,64 @@
+{
+  "namespace": "favorite",
+  "type": "record",
+  "name": "FavoriteProductValue",
+  "fields": [
+    {
+      "name": "id",
+      "type": [
+        "null",
+        "long"
+      ],
+      "default": null
+    },
+    {
+      "name": "createdAt",
+      "type": [
+        "null",
+        "string"
+      ],
+      "default": null
+    },
+    {
+      "name": "product",
+      "type": [
+        "null",
+        {
+          "name": "ProductLink",
+          "type": "record",
+          "fields": [
+            {
+              "name": "id",
+              "type": [
+                "null",
+                "long"
+              ],
+              "default": null
+            }
+          ]
+        }
+      ],
+      "default": null
+    },
+    {
+      "name": "owner",
+      "type": [
+        "null", {
+          "name": "UserLink",
+          "type" : "record",
+          "fields": [
+            {
+              "name": "id",
+              "type": [
+                "null",
+                "long"
+              ],
+              "default": null
+            }
+          ]
+        }
+      ],
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/laboratory/Laboratory/Key.avsc

@@ -0,0 +1,15 @@
+{
+  "namespace": "laboratory",
+  "type": "record",
+  "name": "LaboratoryKey",
+  "fields": [
+    {
+      "name": "id",
+      "type": [
+        "null",
+        "long"
+      ],
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/laboratory/Laboratory/Value.avsc

@@ -0,0 +1,23 @@
+{
+  "namespace": "laboratory",
+  "type": "record",
+  "name": "LaboratoryValue",
+  "fields": [
+    {
+      "name": "id",
+      "type": [
+        "null",
+        "long"
+      ],
+      "default": null
+    },
+    {
+      "name": "name",
+      "type": [
+        "null",
+        "string"
+      ],
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/product/Product/Key.avsc

@@ -0,0 +1,15 @@
+{
+  "namespace": "product",
+  "type": "record",
+  "name": "ProductKey",
+  "fields": [
+    {
+      "name": "id",
+      "type": [
+        "null",
+        "long"
+      ],
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/product/Product/Value.avsc

@@ -0,0 +1,137 @@
+{
+  "namespace": "product",
+  "type": "record",
+  "name": "ProductValue",
+  "fields": [
+    {
+      "name": "id",
+      "type": [
+        "null",
+        "long"
+      ],
+      "default": null
+    },
+    {
+      "name": "name",
+      "type": [
+        "null",
+        "string"
+      ],
+      "default": null
+    },
+    {
+      "name": "status",
+      "type": [
+        "null",
+        "string"
+      ],
+      "default": null
+    },
+    {
+      "name": "barcodes",
+      "type": [
+        "null",
+        {
+          "name": "Barcodes",
+          "type": "record",
+          "fields": [
+            {
+              "name": "cip",
+              "type": [
+                "null",
+                "string"
+              ],
+              "doc": "",
+              "default": null
+            },
+            {
+              "name": "cip13",
+              "type": [
+                "null",
+                "string"
+              ],
+              "doc": "",
+              "default": null
+            },
+            {
+              "name": "eans",
+              "type": [
+                "null",
+                {
+                  "type": "array",
+                  "items": "string"
+                }
+              ],
+              "doc": "",
+              "default": null
+            },
+            {
+              "name": "principal",
+              "type": [
+                "null",
+                "string"
+              ],
+              "doc": "The principal is the referent barcode (for display, invoices, ...) ",
+              "default": null
+            }
+          ]
+        }
+      ],
+      "default": null
+    },
+    {
+      "name": "laboratory",
+      "type": [
+        "null",
+        {
+          "name": "LaboratoryLink",
+          "type": "record",
+          "fields": [
+            {
+              "name": "id",
+              "type": [
+                "null",
+                "long"
+              ],
+              "default": null
+            }
+          ]
+        }
+      ],
+      "default": null
+    },
+    {
+      "name": "unitWeight",
+      "type": [
+        "null",
+        "double"
+      ],
+      "default": null
+    },
+    {
+      "name": "storageType",
+      "type": [
+        "null",
+        "string"
+      ],
+      "default": null
+    },
+    {
+      "name": "type",
+      "type": [
+        "null",
+        "TypeValue"
+      ],
+      "doc": "",
+      "default": null
+    },
+    {
+      "name": "restricted",
+      "type": [
+        "null",
+        "boolean"
+      ],
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/product/SecondaryType/Key.avsc

@@ -0,0 +1,15 @@
+{
+  "namespace": "product",
+  "type": "record",
+  "name": "SecondaryTypeKey",
+  "fields": [
+    {
+      "name": "id",
+      "type": [
+        "null",
+        "string"
+      ],
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/product/SecondaryType/Value.avsc

@@ -0,0 +1,25 @@
+{
+  "namespace": "product",
+  "type": "record",
+  "name": "SecondaryTypeValue",
+  "fields": [
+    {
+      "name": "id",
+      "type": [
+        "null",
+        "string"
+      ],
+      "doc": "Unique identifier of the secondary type",
+      "default": null
+    },
+    {
+      "name": "name",
+      "type": [
+        "null",
+        "string"
+      ],
+      "doc": "Secondary type of a product",
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/product/Type/Key.avsc

@@ -0,0 +1,15 @@
+{
+  "namespace": "product",
+  "type": "record",
+  "name": "TypeKey",
+  "fields": [
+    {
+      "name": "id",
+      "type": [
+        "null",
+        "string"
+      ],
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/product/Type/Value.avsc

@@ -0,0 +1,25 @@
+{
+  "namespace": "product",
+  "type": "record",
+  "name": "TypeValue",
+  "fields": [
+    {
+      "name": "id",
+      "type": [
+        "null",
+        "string"
+      ],
+      "doc": "Unique identifier of the type",
+      "default": null
+    },
+    {
+      "name": "name",
+      "type": [
+        "null",
+        "string"
+      ],
+      "doc": "Principal type of a product",
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/product/Vat/Key.avsc

@@ -0,0 +1,15 @@
+{
+  "namespace": "product",
+  "type": "record",
+  "name": "VatKey",
+  "fields": [
+    {
+      "name": "id",
+      "type": [
+        "null",
+        "string"
+      ],
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/product/Vat/Value.avsc

@@ -0,0 +1,34 @@
+{
+  "namespace": "product",
+  "type": "record",
+  "name": "VatValue",
+  "fields": [
+    {
+      "name": "id",
+      "type": [
+        "null",
+        "string"
+      ],
+      "doc": "Unique identifier of vat",
+      "default": null
+    },
+    {
+      "name": "name",
+      "type": [
+        "null",
+        "string"
+      ],
+      "doc": "Unique name of vat",
+      "default": null
+    },
+    {
+      "name": "value",
+      "type": [
+        "null",
+        "double"
+      ],
+      "doc": "Value of the vat in percent",
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/sale-offer/AnyIdentifiedDistributionMode/Value.avsc

@@ -0,0 +1,47 @@
+{
+  "namespace": "sale_offer",
+  "type": "record",
+  "doc": "",
+  "name": "AnyIdentifiedDistributionMode",
+  "fields": [
+    {
+      "name": "type",
+      "type": ["null", "string"],
+      "doc": "Type of distribution for this ad",
+      "default": null
+    },
+    {
+      "name": "ranges",
+      "type": ["null", {
+        "type": "array",
+        "items": "IdentifiedDistributionRange"
+      }],
+      "doc": "Available range to buy product.",
+      "default": null
+    },
+    {
+      "name": "unitPrice",
+      "type": ["null", "double"],
+      "doc": "The unit price as a decimal.",
+      "default": null
+    },
+    {
+      "name": "minimalQuantity",
+      "type": ["null", "int"],
+      "doc": "Minimal quantity.",
+      "default": null
+    },
+    {
+      "name": "maximalQuantity",
+      "type": ["null", "int"],
+      "doc": "Maximal quantity.",
+      "default": null
+    },
+    {
+      "name": "soldBy",
+      "type": ["null", "int"],
+      "doc": "Sold by this step value.",
+      "default": null
+    }
+  ]
+}

lcdp_api-1.12.27/event/sale-offer/IdentifiedDistributionRange/Value.avsc

@@ -0,0 +1,39 @@
+{
+  "namespace": "sale_offer",
+  "type": "record",
+  "doc": "",
+  "name": "IdentifiedDistributionRange",
+  "fields": [
+    {
+      "name": "id",
+      "type": ["null", "long"],
+      "doc": "Range id.",
+      "default": null
+    },
+    {
+      "name": "quantity",
+      "type": ["null", "int"],
+      "doc": "Number of item per batch",
+      "default": null
+    },
+    {
+      "name": "unitPrice",
+      "type": ["null", "double"],
+      "doc": "The unit price as a decimal.",
+      "default": null
+    },
+    {
+      "name": "freeUnits",
+      "type": ["null", "int"],
+      "doc": "Number of free units per batch",
+      "default": null
+    },
+    {
+      "name": "rebate",
+      "type": ["null", "int"],
+      "doc": "Rebate for this distribution range",
+      "default": null
+    }
+  ]
+
+}

lcdp_api-1.12.27/event/sale-offer/SaleOffer/Key.avsc

@@ -0,0 +1,15 @@
+{
+  "namespace": "sale_offer",
+  "type": "record",
+  "name": "SaleOfferKey",
+  "fields": [
+    {
+      "name": "reference",
+      "type": [
+        "null",
+        "string"
+      ],
+      "default": null
+    }
+  ]
+}