allOf¶
OpenAPI supports inheritance through the allOf directive.
See also
- OpenAPI allOf documentation
OpenAPI documentation for the allOf directive.
- Inheritance
OpenAlchemy documentation for the allOf directive.
OpenAlchemy interprets allOf to mean that the schemas in the directive are to be merged to form the final schema in place of the allOf directive. This allows for re-use of general schemas for particular schemas.
Column¶
When this is done for a property of an object, a generic definition for a property can be used as a base for properties. For example, the following OpenAPI specification defines generic IdBase and NameBase properties which are then used to define the Id and Name properties for the Employee and Division schemas:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 | openapi: "3.0.0"
info:
title: Test Schema
description: API to illustrate allOf usage for columns.
version: "0.1"
paths:
/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"
/division:
get:
summary: Used to retrieve all divisions.
responses:
200:
description: Return all divisions from the database.
content:
application/json:
schema:
type: array
items:
"$ref": "#/components/schemas/Division"
components:
schemas:
IdBase:
type: integer
description: Base for the id schema of an object.
example: 0
x-primary-key: true
NameBase:
type: string
description: The name of the object.
example: Object 1.
Employee:
description: Person that works for a company.
type: object
x-tablename: employee
properties:
id:
allOf:
- "$ref": "#/components/schemas/IdBase"
- description: Unique identifier for the employee.
name:
allOf:
- "$ref": "#/components/schemas/NameBase"
- description: The name of the employee.
example: David Andersson
salary:
type: number
description: The amount of money the employee is paid.
example: 1000000.00
Division:
description: A part of a company.
type: object
x-tablename: division
properties:
id:
allOf:
- "$ref": "#/components/schemas/IdBase"
- description: Unique identifier for the division.
name:
allOf:
- "$ref": "#/components/schemas/NameBase"
- description: The name of the division.
example: Engineering.
|
When the specification is fed to OpenAlchemy, the Id and Name columns for the employee and division tables are based on the IdBase and NameBase schemas, merged with any specific directives on the respective properties of the Employee and Division schemas. This is an implementation of the inheritance paradigm in software engineering:
1 2 3 | from open_alchemy import init_yaml
init_yaml("column-example-spec.yml", models_filename="column_models_auto.py")
|
OpenAlchemy will generate the following typed models:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | """Autogenerated SQLAlchemy models based on OpenAlchemy models."""
# pylint: disable=no-member,super-init-not-called,unused-argument
import typing
import sqlalchemy
from sqlalchemy import orm
from open_alchemy import models
Base = models.Base # type: ignore
class EmployeeDict(typing.TypedDict, total=False):
"""TypedDict for properties that are not required."""
id: typing.Optional[int]
name: typing.Optional[str]
salary: typing.Optional[float]
class TEmployee(typing.Protocol):
"""
SQLAlchemy model protocol.
Person that works for a company.
Attrs:
id: Unique identifier for the employee.
name: The name of the employee.
salary: The amount of money the employee is paid.
"""
# SQLAlchemy properties
__table__: sqlalchemy.Table
__tablename__: str
query: orm.Query
# Model properties
id: "sqlalchemy.Column[typing.Optional[int]]"
name: "sqlalchemy.Column[typing.Optional[str]]"
salary: "sqlalchemy.Column[typing.Optional[float]]"
def __init__(
self,
id: typing.Optional[int] = None,
name: typing.Optional[str] = None,
salary: typing.Optional[float] = None,
) -> None:
"""
Construct.
Args:
id: Unique identifier for the employee.
name: The name of the employee.
salary: The amount of money the employee is paid.
"""
...
@classmethod
def from_dict(
cls,
id: typing.Optional[int] = None,
name: typing.Optional[str] = None,
salary: typing.Optional[float] = None,
) -> "TEmployee":
"""
Construct from a dictionary (eg. a POST payload).
Args:
id: Unique identifier for the employee.
name: The name of the employee.
salary: The amount of money the employee is paid.
Returns:
Model instance based on the dictionary.
"""
...
@classmethod
def from_str(cls, value: str) -> "TEmployee":
"""
Construct from a JSON string (eg. a POST payload).
Returns:
Model instance based on the JSON string.
"""
...
def to_dict(self) -> EmployeeDict:
"""
Convert to a dictionary (eg. to send back for a GET request).
Returns:
Dictionary based on the model instance.
"""
...
def to_str(self) -> str:
"""
Convert to a JSON string (eg. to send back for a GET request).
Returns:
JSON string based on the model instance.
"""
...
Employee: typing.Type[TEmployee] = models.Employee # type: ignore
class DivisionDict(typing.TypedDict, total=False):
"""TypedDict for properties that are not required."""
id: typing.Optional[int]
name: typing.Optional[str]
class TDivision(typing.Protocol):
"""
SQLAlchemy model protocol.
A part of a company.
Attrs:
id: Unique identifier for the division.
name: The name of the division.
"""
# SQLAlchemy properties
__table__: sqlalchemy.Table
__tablename__: str
query: orm.Query
# Model properties
id: "sqlalchemy.Column[typing.Optional[int]]"
name: "sqlalchemy.Column[typing.Optional[str]]"
def __init__(
self, id: typing.Optional[int] = None, name: typing.Optional[str] = None
) -> None:
"""
Construct.
Args:
id: Unique identifier for the division.
name: The name of the division.
"""
...
@classmethod
def from_dict(
cls, id: typing.Optional[int] = None, name: typing.Optional[str] = None
) -> "TDivision":
"""
Construct from a dictionary (eg. a POST payload).
Args:
id: Unique identifier for the division.
name: The name of the division.
Returns:
Model instance based on the dictionary.
"""
...
@classmethod
def from_str(cls, value: str) -> "TDivision":
"""
Construct from a JSON string (eg. a POST payload).
Returns:
Model instance based on the JSON string.
"""
...
def to_dict(self) -> DivisionDict:
"""
Convert to a dictionary (eg. to send back for a GET request).
Returns:
Dictionary based on the model instance.
"""
...
def to_str(self) -> str:
"""
Convert to a JSON string (eg. to send back for a GET request).
Returns:
JSON string based on the model instance.
"""
...
Division: typing.Type[TDivision] = models.Division # type: ignore
|
Model¶
allOf also works for objects. For example, the following OpenAPI specification defines a base schema with an id and name property. This is then used to define the Employee and Division schemas:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 | openapi: "3.0.0"
info:
title: Test Schema
description: API to illustrate OpenAlchemy MVP.
version: "0.1"
paths:
/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"
/division:
get:
summary: Used to retrieve all divisions.
responses:
200:
description: Return all divisions from the database.
content:
application/json:
schema:
type: array
items:
"$ref": "#/components/schemas/Division"
components:
schemas:
IdNameBase:
description: Base schema with an id and name column.
type: object
properties:
id:
type: integer
description: Unique identifier for the object.
example: 0
x-primary-key: true
name:
type: string
description: The name of the object.
example: Object 1.
Division:
allOf:
- "$ref": "#/components/schemas/IdNameBase"
- description: A part of a company.
x-tablename: division
Employee:
allOf:
- "$ref": "#/components/schemas/IdNameBase"
- description: Person that works for a company.
x-tablename: employee
type: object
properties:
salary:
type: number
description: The amount of money the employee is paid.
example: 1000000.00
|
The following file uses OpenAlchemy to generate the SQLAlchemy models:
1 2 3 | from open_alchemy import init_yaml
init_yaml("model-example-spec.yml", models_filename="model_models_auto.py")
|
OpenAlchemy will generate the following typed models:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | """Autogenerated SQLAlchemy models based on OpenAlchemy models."""
# pylint: disable=no-member,super-init-not-called,unused-argument
import typing
import sqlalchemy
from sqlalchemy import orm
from open_alchemy import models
Base = models.Base # type: ignore
class DivisionDict(typing.TypedDict, total=False):
"""TypedDict for properties that are not required."""
id: typing.Optional[int]
name: typing.Optional[str]
class TDivision(typing.Protocol):
"""
SQLAlchemy model protocol.
A part of a company.
Attrs:
id: Unique identifier for the object.
name: The name of the object.
"""
# SQLAlchemy properties
__table__: sqlalchemy.Table
__tablename__: str
query: orm.Query
# Model properties
id: "sqlalchemy.Column[typing.Optional[int]]"
name: "sqlalchemy.Column[typing.Optional[str]]"
def __init__(
self, id: typing.Optional[int] = None, name: typing.Optional[str] = None
) -> None:
"""
Construct.
Args:
id: Unique identifier for the object.
name: The name of the object.
"""
...
@classmethod
def from_dict(
cls, id: typing.Optional[int] = None, name: typing.Optional[str] = None
) -> "TDivision":
"""
Construct from a dictionary (eg. a POST payload).
Args:
id: Unique identifier for the object.
name: The name of the object.
Returns:
Model instance based on the dictionary.
"""
...
@classmethod
def from_str(cls, value: str) -> "TDivision":
"""
Construct from a JSON string (eg. a POST payload).
Returns:
Model instance based on the JSON string.
"""
...
def to_dict(self) -> DivisionDict:
"""
Convert to a dictionary (eg. to send back for a GET request).
Returns:
Dictionary based on the model instance.
"""
...
def to_str(self) -> str:
"""
Convert to a JSON string (eg. to send back for a GET request).
Returns:
JSON string based on the model instance.
"""
...
Division: typing.Type[TDivision] = models.Division # type: ignore
class EmployeeDict(typing.TypedDict, total=False):
"""TypedDict for properties that are not required."""
salary: typing.Optional[float]
id: typing.Optional[int]
name: typing.Optional[str]
class TEmployee(typing.Protocol):
"""
SQLAlchemy model protocol.
Person that works for a company.
Attrs:
salary: The amount of money the employee is paid.
id: Unique identifier for the object.
name: The name of the object.
"""
# SQLAlchemy properties
__table__: sqlalchemy.Table
__tablename__: str
query: orm.Query
# Model properties
salary: "sqlalchemy.Column[typing.Optional[float]]"
id: "sqlalchemy.Column[typing.Optional[int]]"
name: "sqlalchemy.Column[typing.Optional[str]]"
def __init__(
self,
salary: typing.Optional[float] = None,
id: typing.Optional[int] = None,
name: typing.Optional[str] = None,
) -> None:
"""
Construct.
Args:
salary: The amount of money the employee is paid.
id: Unique identifier for the object.
name: The name of the object.
"""
...
@classmethod
def from_dict(
cls,
salary: typing.Optional[float] = None,
id: typing.Optional[int] = None,
name: typing.Optional[str] = None,
) -> "TEmployee":
"""
Construct from a dictionary (eg. a POST payload).
Args:
salary: The amount of money the employee is paid.
id: Unique identifier for the object.
name: The name of the object.
Returns:
Model instance based on the dictionary.
"""
...
@classmethod
def from_str(cls, value: str) -> "TEmployee":
"""
Construct from a JSON string (eg. a POST payload).
Returns:
Model instance based on the JSON string.
"""
...
def to_dict(self) -> EmployeeDict:
"""
Convert to a dictionary (eg. to send back for a GET request).
Returns:
Dictionary based on the model instance.
"""
...
def to_str(self) -> str:
"""
Convert to a JSON string (eg. to send back for a GET request).
Returns:
JSON string based on the model instance.
"""
...
Employee: typing.Type[TEmployee] = models.Employee # type: ignore
|
See also