Skip to content

Commit

Permalink
Documentation updates (#407)
Browse files Browse the repository at this point in the history
* nodejs querying is by oData v4 now

* make the location of the yml file clearer

* add postgres as a db kind

* Apply suggestions from code review

---------

Co-authored-by: Nigel James <nigel.james@plantracker.com.au>
Co-authored-by: René Jeglinsky <rene.jeglinsky@sap.com>
  • Loading branch information
3 people authored Sep 6, 2023
1 parent e1c8322 commit 2f7c483
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 7 deletions.
2 changes: 0 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,3 @@
"**/CONTRIBUTING.md": true,
"**/LICENSE*": true,
"**/node_modules/": true
}
}
6 changes: 3 additions & 3 deletions get-started/in-a-nutshell.md
Original file line number Diff line number Diff line change
Expand Up @@ -402,9 +402,9 @@ c.s.c.s.impl.persistence.CsvDataLoader : Filling sap.capire.bookshop.Books fro

Now that we've a connected, fully capable SQL database, filled with some initial data, we can send complex OData queries, served by the built-in generic providers:

- _[…/Books?$select=ID,title](http://localhost:4004/browse/Books?$select=ID,title)_ {.impl .node}
- _[…/Authors?$search=Bro](http://localhost:4004/admin/Authors?$search=Bro)_ {.impl .node}
- _[…/Authors?$expand=books($select=ID,title)](http://localhost:4004/admin/Authors?$expand=books($select=ID,title))_ {.impl .node}
- _[…/Books?$select=ID,title](http://localhost:4004/odata/v4/browse/Books?$select=ID,title)_ {.impl .node}
- _[…/Authors?$search=Bro](http://localhost:4004/odata/v4/admin/Authors?$search=Bro)_ {.impl .node}
- _[…/Authors?$expand=books($select=ID,title)](http://localhost:4004/odata/v4/admin/Authors?$expand=books($select=ID,title))_ {.impl .node}
- _[…/Books?$select=ID,title](http://localhost:8080/odata/v4/browse/Books?$select=ID,title)_ {.impl .java}
- _[…/Authors?$search=Bro](http://localhost:8080/odata/v4/AdminService/Authors?$search=Bro)_ {.impl .java}
- _[…/Authors?$expand=books($select=ID,title)](http://localhost:8080/odata/v4/AdminService/Authors?$expand=books($select=ID,title))_ {.impl .java}
Expand Down
2 changes: 1 addition & 1 deletion guides/databases-postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ You can use Docker to run a PostgreSQL database locally as follows:

1. Install and run [Docker Desktop](https://www.docker.com)

2. Create a file like that:
2. Create the following file in your project root directory:
::: code-group

```yaml [pg.yml]
Expand Down
2 changes: 1 addition & 1 deletion guides/databases.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ The previous setups auto-wire things through configuration presets, which are au

The config options are as follows:

- `kind` — a name of a preset, like `sql`, `sqlite`, or `hana`
- `kind` — a name of a preset, like `sql`, `sqlite`, `postgres`, or `hana`
- `impl` — the module name of a CAP database service implementation
- `credentials` — an object with db-specific configurations, most commonly `url`

Expand Down

0 comments on commit 2f7c483

Please sign in to comment.