Skip to content
This repository has been archived by the owner on Jul 1, 2024. It is now read-only.

Commit

Permalink
Merge pull request #143 from omahs/patch-1
Browse files Browse the repository at this point in the history
Fix: typos
  • Loading branch information
vikiival authored Feb 22, 2023
2 parents 1e7f0b5 + 0c8589b commit ede67eb
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Note that the type bundle format for typegen is slightly different from `Overrid
```javascript
{
types: {}, // top-level type definitions, as `.types` option of `ApiPromise`
typesAlias: {}, // top-level type alieases, as `.typesAlias` option of `ApiPromise`
typesAlias: {}, // top-level type aliases, as `.typesAlias` option of `ApiPromise`
versions: [ // spec version specific overrides, same as `OverrideBundleDefinition.types` of `polkadot.js`
{
minmax: [0, 1010] // spec range
Expand All @@ -34,7 +34,7 @@ Note that the type bundle format for typegen is slightly different from `Overrid

The schema file defines the shape of the final GraphQL API and has very few limitations. Designing the schema file is very similar to the design of the database schema. As a rule of thumb, the schema should represent high level domain specific entities and relations between them, to make data fetching and filtering easy for the API consumers.

Typically, the API is consumed by the frontend and mobile apps, so it's a good idea to design the schema even before you go on with implementing the processor mappings. In fact, the processor is completely indpendent from the GraphQL server serving the API, so you can experiment how the API looks like.
Typically, the API is consumed by the frontend and mobile apps, so it's a good idea to design the schema even before you go on with implementing the processor mappings. In fact, the processor is completely independent from the GraphQL server serving the API, so you can experiment how the API looks like.

## How do I update my schema?

Expand All @@ -56,7 +56,7 @@ npm run build

Now you have to options: either create a migration for an incremental schema update or recreate the whole schema from scratch.

During the development process, recreating the schema is often more convenient. However, if you already have a running API in production and don't want to resync it, having an incremental update is preferrable (but requires data backfilling).
During the development process, recreating the schema is often more convenient. However, if you already have a running API in production and don't want to resync it, having an incremental update is preferable (but requires data backfilling).

### Option 1: Recreate schema from scratch

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ make process
# and run
make serve

# 7. Now you can see the resuls by visiting the localhost:4350/graphql
# 7. Now you can see the results by visiting the localhost:4350/graphql
```

## Dev flow
Expand Down

0 comments on commit ede67eb

Please sign in to comment.