Update documentation

Author: David Andersson

CHANGELOG.md

@@ -23,6 +23,7 @@
 - Add check enforcing unique `x-tablename` values.
 - Add check enforcing unique `x-secondary` values.
 - Add custom association schemas validation
+- Add support for custom association tables
 
 ## Version 1.5.4 - 2020-10-10
 

README.md

@@ -143,6 +143,7 @@ An example API has been defined using connexion and Flask here:
 - one to one relationships,
 - one to many relationships,
 - many to many relationships,
+- many to many relationships with custom association tables,
 - custom foreign keys for relationships,
 - back references for relationships,
 - `allOf` inheritance for columns and models,

examples/relationship/many_to_many/pre-defined-example-spec.yml

@@ -0,0 +1,85 @@
+openapi: "3.0.0"
+
+info:
+  title: Test Schema
+  description: API to illustrate Many to Many Relationships.
+  version: "0.1"
+
+paths:
+  /project:
+    get:
+      summary: Used to retrieve all projects.
+      responses:
+        200:
+          description: Return all projects from the database.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  "$ref": "#/components/schemas/Project"
+  /employee:
+    get:
+      summary: Used to retrieve all employees.
+      responses:
+        200:
+          description: Return all employees from the database.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  "$ref": "#/components/schemas/Employee"
+
+components:
+  schemas:
+    Project:
+      description: A large sized business objective.
+      type: object
+      x-tablename: project
+      properties:
+        id:
+          type: integer
+          description: Unique identifier for the project.
+          example: 0
+          x-primary-key: true
+        name:
+          type: string
+          description: The name of the project.
+          example: Expand to the USA
+    Employee:
+      description: Person that works for a company.
+      type: object
+      x-tablename: employee
+      properties:
+        id:
+          type: integer
+          description: Unique identifier for the employee.
+          example: 0
+          x-primary-key: true
+        name:
+          type: string
+          description: The name of the employee.
+          example: David Andersson
+        projects:
+          type: array
+          items:
+            allOf:
+              - "$ref": "#/components/schemas/Project"
+              - x-secondary: employee_project
+          description: The projects the employee is working on.
+    EmployeeProject:
+      type: object
+      x-tablename: employee_project
+      properties:
+        employee_id:
+          type: integer
+          x-primary-key: true
+          x-foreign-key: employee.id
+        project_id:
+          type: integer
+          x-primary-key: true
+          x-foreign-key: project.id
+      required:
+        - employee_id
+        - project_id

examples/relationship/many_to_many/pre_defined_models.py

@@ -0,0 +1,3 @@
+from open_alchemy import init_yaml
+
+init_yaml("pre-defined-example-spec.yml", models_filename="pre_defined_models_auto.py")