Repository navigation
docs: move the API reference to docs/api.md and correct environment variables - #100
Merged
Merged
Conversation
The docs site has no API page for QR codes, webhooks, SDK endpoints, health or debug routes, so the list moves to docs/ rather than being cut. Adds the template routes and the template-path resolve route, which were missing.
Replace SERVICE_DOMAIN with SHORTLINK_DOMAIN, the variable Core reads for QR code URLs, and show its value with the scheme, because the value is used as the start of the URL. Remove JWT_SECRET and the SMTP settings, which Core does not read, and document TRUST_EDGE_BOT_HEADER. Pass SHORTLINK_DOMAIN and TRUST_EDGE_BOT_HEADER through docker-compose.yml so that setting them in .env reaches the container.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/api.md, leaving a link in the README. Adds the/api/templatesroutes and/api/sdk/v1/resolve/:templateSlug/:shortCode, which were missing.SHORTLINK_DOMAIN: replaces the unreadSERVICE_DOMAINin.env.example.docs/configuration.mdnow shows the value with its scheme, because the value is used as the start of the QR code URL. Without a scheme, the encoded URL has none either.JWT_SECRETand the commented SMTP settings, which Core doesn't read.TRUST_EDGE_BOT_HEADER: now documented indocs/configuration.md.docker-compose.yml: passesSHORTLINK_DOMAINandTRUST_EDGE_BOT_HEADERthrough, so setting them in.envreaches the container. An unset value behaves as before.llms.txt: no longer saysSHORTLINK_DOMAINis used in SDK responses. Only the QR route reads it.Testing
docker compose config -qpasses. No application code changed.