Skip to content

Commit

Permalink
Doc improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
wyfo committed Dec 19, 2020
1 parent 9371419 commit e6f4f74
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/pydantic_difference.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The question is often asked, so it is answered in a dedicated section. Here are

Better performance, and but also with more functionalities: [dynamic aliasing](json_schema.md#dynamic-aliasing-and-default-aliaser), [conversions](conversions.md), [merged fields](data_model.md#composition-over-inheritance---composed-dataclasses-merging), etc.

### *Apischema* can generate *GraphQL* schema from your resolvers
### *Apischema* can generate [*GraphQL* schema](graphql/overview.md) from your resolvers

Not just a simple printable schema but a complete `graphql.GraphQLSchema` which can be used to execute your queries/mutations/subscriptions through your resolvers/subscribers, powered by *Apischema* (de)serialization and conversions features.

Expand Down
4 changes: 2 additions & 2 deletions docs/validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,13 @@ In the example, validator yield a tuple of an "error path" and the error message

- a string
- an integer (for list indices)
- a dataclass field (obtained with `get_fields`)
- a dataclass field (obtained with `apischema.fields.fields`)
- a tuple of this 3 components.

`yield` can also be used with only an error message.

!!! note
For dataclass field error path, it's advised to use `get_fields` instead of raw string, because it will take in account potential aliasing and it will be easier to rename field with IDE refactoring.
For dataclass field error path, it's advised to use `apischema.fields.fields` instead of raw string, because it will take in account potential aliasing and it will be easier to rename field with IDE refactoring.

### Discard

Expand Down

0 comments on commit e6f4f74

Please sign in to comment.