Adding an alias named contents to the html property of the shell-empty component#1122
Merged
lovasoa merged 4 commits intosqlpage:mainfrom Nov 22, 2025
Merged
Adding an alias named contents to the html property of the shell-empty component#1122lovasoa merged 4 commits intosqlpage:mainfrom
lovasoa merged 4 commits intosqlpage:mainfrom
Conversation
lovasoa
requested changes
Nov 22, 2025
Collaborator
lovasoa
left a comment
lovasoa
left a comment
There was a problem hiding this comment.
Good idea, thanks @olivierauverlot . I think we should go further and mention "contents" as the primary name of the property.
Comment on lines
+1538
to
+1541
| ### Return data in a format other than HTML | ||
| If you create a RESTful API with SQLPage and the data format transmitted to the client is not HTML, | ||
| you can use an alias named `contents` to enhance the readability of your code. | ||
| This approach is particularly useful for returning data formats such as JSON or XML. |
Collaborator
There was a problem hiding this comment.
You are perfectly right, and I would even go further. I think the docs should mention "html" as being an alias for "contents", not the other way around. "html" is indeed misleading.
We should have a markdown code block here to show a quickly copy-pastable example of both setting the http header and the contents.
We should probably also mention the download component here : https://sql-page.com/component.sql?component=download
Contributor
Author
|
I am glad that we share the same opinion on this matter. I have made the modifications in the documentation :) |
lovasoa
approved these changes
Nov 22, 2025
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
If you create a RESTful API with SQLPage and the data format transmitted to the client is not HTML, you can use an alias named
contentsto enhance the readability of your code. This approach is particularly useful for returning data formats such as JSON or XML.For this use case, using the
htmlproperty is inconsistent and can be confusing when reading the code.