Skip to content

Update logical data abstraction docs to show use of id_field attribute #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
akira-dev merged 1 commit into from
Jun 26, 2018
Merged

Update logical data abstraction docs to show use of id_field attribute #94

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/logical_data_abstraction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ Now let's create the logical abstraction to illustrate this concept.
related_view_kwargs={'id': '<id>'},
many=True,
schema='ComputerSchema',
type_='computer')
type_='computer',
id_field='computer_id')


class ComputerSchema(Schema):
Expand All @@ -81,6 +82,7 @@ First, take a look of Person compared to PersonSchema:

* we can see that Person has an attribute named "password" and we don't want to expose it through the api so it is not set in PersonSchema
* PersonSchema has an attribute named "display_name" that is the result of concatenation of name and email
* In the computers Relationship() defined on PersonSchema we have set the id_field to "computer_id" as that is the primary key on the Computer(db.model). Without seeting id_field the relationship looks for a field called "id".

Second, take a look of Computer compared to ComputerSchema:

Expand Down