Api docs bijgewerkt

ConductionNL · Jan 13, 2020 · f6e65e2 · f6e65e2
1 parent 7c060e5
commit f6e65e2
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 59 deletions.
diff --git a/api/public/schema/openapi.yaml b/api/public/schema/openapi.yaml
@@ -1229,14 +1229,17 @@ components:
           description: 'The RSIN of the organization that ownes this proces'
           type: string
         price:
+          readOnly: true
           description: 'The price of this product'
           type: string
         priceCurrency:
+          readOnly: true
           description: 'The currency of this product in an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format'
           externalDocs:
             url: 'http://schema.org/priceCurrency'
           type: string
         tax:
+          readOnly: true
           description: 'The total tax over the order'
           type: string
         createdAt:
@@ -1257,14 +1260,12 @@ components:
       required:
         - name
         - targetOrganization
-        - price
     Order-write:
       type: object
       description: 'An entity representing an order.'
       required:
         - name
         - targetOrganization
-        - price
       properties:
         name:
           description: 'The name of the order'
@@ -1275,17 +1276,6 @@ components:
         targetOrganization:
           description: 'The RSIN of the organization that ownes this proces'
           type: string
-        price:
-          description: 'The price of this product'
-          type: string
-        priceCurrency:
-          description: 'The currency of this product in an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format'
-          externalDocs:
-            url: 'http://schema.org/priceCurrency'
-          type: string
-        tax:
-          description: 'The total tax over the order'
-          type: string
         items:
           description: 'The items in this order'
           type: array
@@ -1329,14 +1319,17 @@ components:
           description: 'The RSIN of the organization that ownes this proces'
           type: string
         price:
+          readOnly: true
           description: 'The price of this product'
           type: string
         priceCurrency:
+          readOnly: true
           description: 'The currency of this product in an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format'
           externalDocs:
             url: 'http://schema.org/priceCurrency'
           type: string
         tax:
+          readOnly: true
           description: 'The total tax over the order'
           type: string
         createdAt:
@@ -1357,14 +1350,12 @@ components:
       required:
         - name
         - targetOrganization
-        - price
     'Order:jsonld-write':
       type: object
       description: 'An entity representing an order.'
       required:
         - name
         - targetOrganization
-        - price
       properties:
         '@context':
           readOnly: true
@@ -1384,17 +1375,6 @@ components:
         targetOrganization:
           description: 'The RSIN of the organization that ownes this proces'
           type: string
-        price:
-          description: 'The price of this product'
-          type: string
-        priceCurrency:
-          description: 'The currency of this product in an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format'
-          externalDocs:
-            url: 'http://schema.org/priceCurrency'
-          type: string
-        tax:
-          description: 'The total tax over the order'
-          type: string
         items:
           description: 'The items in this order'
           type: array
@@ -1451,22 +1431,13 @@ components:
           type: string
           format: date-time
       required:
-        - name
         - order
         - offer
         - quantity
-        - price
         - taxPercentage
     OrderItem-write:
       type: object
       description: 'An entity representing an item of an order.'
-      required:
-        - name
-        - order
-        - offer
-        - quantity
-        - price
-        - taxPercentage
       properties:
         name:
           description: 'The name of the object'
@@ -1499,6 +1470,11 @@ components:
         taxPercentage:
           description: 'The tax percentage for this offer as an integer e.g. 9% makes 9'
           type: integer
+      required:
+        - order
+        - offer
+        - quantity
+        - taxPercentage
     'OrderItem:jsonld-read':
       type: object
       description: 'An entity representing an item of an order.'
@@ -1554,22 +1530,13 @@ components:
           type: string
           format: date-time
       required:
-        - name
         - order
         - offer
         - quantity
-        - price
         - taxPercentage
     'OrderItem:jsonld-write':
       type: object
       description: 'An entity representing an item of an order.'
-      required:
-        - name
-        - order
-        - offer
-        - quantity
-        - price
-        - taxPercentage
       properties:
         '@context':
           readOnly: true
@@ -1611,6 +1578,11 @@ components:
         taxPercentage:
           description: 'The tax percentage for this offer as an integer e.g. 9% makes 9'
           type: integer
+      required:
+        - order
+        - offer
+        - quantity
+        - taxPercentage
 definitions:
   Order-read:
     properties:
@@ -1644,7 +1616,6 @@ definitions:
     required:
       - name
       - targetOrganization
-      - price
   Order-write:
     properties:
       name:
@@ -1656,20 +1627,13 @@ definitions:
       targetOrganization:
         example: '002851234'
         maxLength: 255
-      price:
-        example: '50.00'
-      priceCurrency:
-        example: EUR
-      tax:
-        example: '21.00'
       customer:
         example: 'https://example.org/people/1'
         format: url
       items: []
     required:
       - name
       - targetOrganization
-      - price
   OrderItem-read:
     properties:
       id:
@@ -1697,9 +1661,7 @@ definitions:
       createdAt: []
       order: []
     required:
-      - name
       - offer
-      - price
       - order
   OrderItem-write:
     properties:
@@ -1724,9 +1686,7 @@ definitions:
         example: '9'
       order: []
     required:
-      - name
       - offer
-      - price
       - order
 tags:
   -

diff --git a/api/public/schema/publiccode.yaml b/api/public/schema/publiccode.yaml
@@ -6,7 +6,7 @@ url: "https://github.com/ConductionNL/Proto-component-commonground"
 landingURL: "orc.zaakonline.nl" 
 isBasedOn: "https://github.com/ConductionNL/Proto-component-commonground.git" 
 softwareVersion: "V.0.1"
-releaseDate: "2020-08-01"
+releaseDate: "2020-13-01"
 logo: orc.zaakonline.nl 
 monochromeLogo: img/logo-mono.svg
 

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -189,8 +189,8 @@ services:
       - MYSQL_PASSWORD=!ChangeMe!
     volumes:
       - db-mysql:/var/lib/mysql:rw 
-    ports:
-     - "3366:3306"
+    #ports:
+    # - "3366:3306"
 
   mercure:
     # In production, you may want to use the managed version of Mercure, https://mercure.rocks