Skip to content

Commit

Permalink
fix relative links
Browse files Browse the repository at this point in the history
  • Loading branch information
sh-rp committed May 27, 2024
1 parent 9d675b2 commit 5fd2d6b
Showing 1 changed file with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ We also have a cool [Google Colab example](https://colab.research.google.com/dri

Features include:

* **[Pagination](../rest_api#pagination) discovery** for each endpoint.
* **[Pagination](./rest_api#pagination) discovery** for each endpoint.
* **Primary key discovery** for each entity.
* **Endpoint relationship mapping** into `dlt` [`transformers`](../../general-usage/resource#process-resources-with-dlttransformer) (e.g., /users/ -> /user/{id}).
* **Payload JSON path [data selector](../rest_api#data-selection) discovery** for results nested in the returned JSON.
* **[Authentication](../rest_api#authentication)** discovery for an API.
* **Payload JSON path [data selector](./rest_api#data-selection) discovery** for results nested in the returned JSON.
* **[Authentication](./rest_api#authentication)** discovery for an API.

## A quick example

Expand Down Expand Up @@ -99,7 +99,7 @@ If you re-generate your pipeline, you will be prompted to continue if this folde

## A closer look at your `rest_api` dictionary in `pokemon/__init__.py`

This file contains the [configuration dictionary](./rest_api#source-configuration) for the rest_api source which is the main result of running this generator. For our Pokemon example, we have used an OpenAPI 3 spec that works out of the box. The result of this dictionary depends on the quality of the spec you are using, whether the API you are querying actually adheres to this spec, and whether our heuristics manage to find the right values. You can edit this file to adapt the behavior of the dlt rest_api accordingly. Please read our [dlt rest_api](../rest_api) docs to learn how to configure the rest_api source with our detailed [Google Colab example](https://colab.research.google.com/drive/1MRZvguOTZj1MlkEGzjiso8lQ_wr1MJRI?usp=sharing#scrollTo=LHGxzf1Ev_yr).
This file contains the [configuration dictionary](./rest_api#source-configuration) for the rest_api source which is the main result of running this generator. For our Pokemon example, we have used an OpenAPI 3 spec that works out of the box. The result of this dictionary depends on the quality of the spec you are using, whether the API you are querying actually adheres to this spec, and whether our heuristics manage to find the right values. You can edit this file to adapt the behavior of the dlt rest_api accordingly. Please read our [dlt rest_api](./rest_api) docs to learn how to configure the rest_api source with our detailed [Google Colab example](https://colab.research.google.com/drive/1MRZvguOTZj1MlkEGzjiso8lQ_wr1MJRI?usp=sharing#scrollTo=LHGxzf1Ev_yr).

The generated dictionary will look something like this:

Expand Down

0 comments on commit 5fd2d6b

Please sign in to comment.