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.

Sign up for GitHub

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

Jump to bottom

docs: ADDON-64957 OAuth Doc Changes #828

Closed
wants to merge 4 commits into from
Closed

docs: ADDON-64957 OAuth Doc Changes #828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f1400eb
docs: ADDON-64957 OAuth Doc Changes
tbalar-splunk Sep 11, 2023
a5973ac
docs: Added warning for Placeholder property
tbalar-splunk Sep 15, 2023
5b968d4
docs: Added warning for Placeholder property
tbalar-splunk Sep 15, 2023
7c3c75c
docs: Remove warning message
tbalar-splunk Sep 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/advanced/oauth_support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ Auth can be used inside the entity tag. Use `type: "oauth"` in the entity list a
- `field`: For now this user must keep it as it is for mandatory fields as mentioned above.
- `help` : This can be changed if user wants to change the help text displayed below field.
- `encrypted` : This should be true if user wants that particular field encrypted else no need to have this parameter.
- `placeholder`: The placeholder for the field.
- `required`: To specify whether the field is required or not. The default value is true.
- `options`:
- `placeholder`: The placeholder for the field.

### Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/entity/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Entity
| field<span class="required-asterisk">*</span> | string | To define a particular entity field. | - |
| label<span class="required-asterisk">*</span> | string | It represents a caption for a field in a user interface. | - |
| [type](./components)<span class="required-asterisk">*</span> | string | To specify the type of entity to be rendered in inputs or configuration form. | - |
| help | string | Help text gives context about a field’s input, such as how the input will be used. It is displayed directly under an input field. | - |
| help | string | Help text gives context about a fields input, such as how the input will be used. It is displayed directly under an input field. | - |
| tooltip | string | Displays a tooltip beside the label. | - |
| defaultValue | string, number or boolean | The initial input value. | - |
| [options](#common-options) | object | To specify an additional attribute for a particular type of entity, such as `items` for a radio bar. | - |
Expand Down
Loading