Improve the readability of the web API Help Page at Web/Services/ #369
Conversation
This file contains 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
Previously most of the API Help page (Web/Services/) was on a single line, when viewed using view-source in the browser. Add line-feeds so that it is easier to read when using view-source.
Pretty-print the JSON when displaying it on the API Help Page
(Web/Services/)
For example this is how a portion of the CreateCustomAttribute
endpoint docs look. Previously the JSON was all on one line, which
made it difficult to read.
Response
{
"links": [
{
"href": "http:\/\/url\/to\/attribute",
"title": "get_custom_attribute"
},
{
"href": "http:\/\/url\/to\/update\/attribute",
"title": "update_custom_attribute"
}
],
"message": null,
"attributeId": 1
}
Request
{
"label": "attribute name",
"type": 1,
"categoryId": 1,
"regex": "validation regex",
"required": true,
"possibleValues": [
"possible",
"values",
"only valid for select list"
],
"sortOrder": 100,
"appliesToIds": [
10
],
"adminOnly": true,
"isPrivate": true,
"secondaryCategoryId": 1,
"secondaryEntityIds": [
1,
2
]
}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Main thing these patches do is to pretty-print the JSON on the help page so that it is easier to read.