@things-factory/operato-hub 4.3.81 → 4.3.82

package/openapi/v1/partner.yaml

@@ -0,0 +1,80 @@
+definitions:
+  Partner:
+    type: 'object'
+    properties:
+      data:
+        type: 'object'
+        properties:
+          bizplace:
+            type: 'object'
+            properties:
+              id:
+                type: 'string'
+                example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
+              name:
+                type: 'string'
+                example: 'XYZ'
+              description:
+                type: 'string'
+                example: 'xyz'
+              address:
+                type: 'string'
+                example: 'xyz'
+              postalCode:
+                type: 'string'
+                example: '42500'
+          partnershipOwner: 
+            type: 'boolean'
+            example: 'false'
+          extType:
+            type: 'string'
+            example: 'warehouse'
+      totalCount:
+        type: 'integer'
+        example: 3
+      limit:
+        type: 'integer'
+        example: 2
+      offset:
+        type: 'integer'
+        example: 2
+    xml:
+      name: 'Partner'
+
+paths:
+  # get-partner-list
+  api/v1/company/get-partner-list: 
+    get:
+      tags:
+        - 'Partner'
+      summary: 'Get list of contact partner.'
+      description: 'Get list of contact partner. Specify bizplace that is within this company.'
+      operationId: 'getBizplaceList'
+      consumes:
+        - 'application/json'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'query'
+          name: 'bizplaceId'
+          type: 'string'
+          description: 'Required to specify the bizplace to search.'
+          required: true
+        - in: 'query'
+          name: 'limit'
+          type: 'integer'
+          default: 100
+          max: 100
+        - in: 'query'
+          name: 'offset'
+          type: 'integer'
+          default: 0
+      responses:
+        '200':
+          description: 'successful operation'
+          content:
+            application/json:
+              schema:
+                type: 'array'
+                items:
+                  $ref: '#/definitions/Partner'