Skip to content
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.

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

rest_api: add troubleshooting section #1371

Merged
merged 6 commits into from
May 31, 2024

Conversation

burnash
Copy link
Collaborator

@burnash burnash commented May 16, 2024

No description provided.

@burnash burnash requested a review from rudolfix May 16, 2024 13:28
@burnash burnash self-assigned this May 16, 2024
@burnash burnash added the documentation Improvements or additions to documentation label May 16, 2024
Copy link

netlify bot commented May 16, 2024

Deploy Preview for dlt-hub-docs ready!

Name Link
🔨 Latest commit a13fbd4
🔍 Latest deploy log https://app.netlify.com/sites/dlt-hub-docs/deploys/6658a34468cf450008398f4a
😎 Deploy Preview https://deploy-preview-1371--dlt-hub-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@rudolfix rudolfix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What I'm lacking here: you do not tell the user when do certain action. I left some comments. Also I think we should mention how to troubleshot autodetections

  • tell the user that is paginator is not specified we try to autodetect one. if autodetection fails or we are not sure, s/he will get a warning in the log. we recommend to put explicit paginator for production code
  • same thing for data_selector. we'll try to detect a valid one but if you are getting weird data in the database you should provide a right one (we log what we guess at the INFO level)

@burnash burnash requested a review from rudolfix May 30, 2024 14:17
rudolfix
rudolfix previously approved these changes May 30, 2024
Copy link
Collaborator

@rudolfix rudolfix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!
really clear

@burnash burnash changed the base branch from devel to master May 30, 2024 16:02
@burnash burnash dismissed rudolfix’s stale review May 30, 2024 16:02

The base branch was changed.

@burnash burnash merged commit bad7645 into master May 31, 2024
40 of 41 checks passed
@burnash burnash deleted the feat/docs/rest_api/add_troubleshooting branch May 31, 2024 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants