Skip to content

Commit aa46556

Browse files
monikakusterivicac
authored andcommitted
538 - update component specification section
1 parent 51bf32e commit aa46556

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

docs/src/content/docs/developer_guide/component_specification/component.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ title: "Component"
55
The component definition is used to specify the properties of a component. Below is an explanation of each method that can be used in the component definition:
66

77
- `component(String name)` - Builds new `ModifiableComponentDefinition` with the specified name. The name defines the component key (backend ID).
8-
- `actions(A... actionDefinitions)` - Specifies the actions that the component can perform.
8+
- [`actions(A... actionDefinitions)`](./action) - Specifies the actions that the component can perform.
99
- `categories(ComponentCategory... category)` - Defines the category or categories that the component belongs to, used to group components together in the UI.
10-
- `connection(ModifiableConnectionDefinition connectionDefinition)` - Sets the connection definition for the component.
10+
- [`connection(ModifiableConnectionDefinition connectionDefinition)`](./connection) - Sets the connection definition for the component.
1111
- `connectionRequired(boolean connectionRequired)` - Indicates whether the component requires a connection to be configured before it can be used.
1212
- `customAction(boolean customAction)` - Indicates if the component is REST-based.
1313
- `description(String description)` - Provides a short description of the component.

docs/src/content/docs/developer_guide/component_specification/connection.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Each authorization type has different properties that are required for successfu
3434

3535
Basic Auth is a simple authentication scheme built into the HTTP protocol. It requires a username and password, which are sent with each request.
3636

37-
```
37+
```java
3838
authorization(AuthorizationType.BASIC_AUTH)
3939
.title("Basic Auth")
4040
.properties(
@@ -50,7 +50,7 @@ authorization(AuthorizationType.BASIC_AUTH)
5050

5151
Bearer Token authentication involves sending a token with each request. This token is typically obtained from an authorization server and represents the user's identity.
5252

53-
```
53+
```java
5454
authorization(AuthorizationType.BEARER_TOKEN)
5555
.title("Bearer Token")
5656
.properties(
@@ -63,7 +63,7 @@ authorization(AuthorizationType.BEARER_TOKEN)
6363

6464
OAuth2 Authorization Code is a robust authorization framework that allows third-party applications to obtain limited access to a web service. It involves redirecting the user to an authorization server to obtain an authorization code, which is then exchanged for an access token.
6565

66-
```
66+
```java
6767
authorization(AuthorizationType.OAUTH2_AUTHORIZATION_CODE)
6868
.title("OAuth2 Authorization Code")
6969
.properties(

docs/src/content/docs/developer_guide/component_specification/property.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,20 @@ title: "Property"
77
The `ModifiableArrayProperty` class is a customizable property type designed to handle array values within a component.
88

99
- `array(String name)` - Initializes a new `ModifiableArrayProperty` with the specified name.
10-
- `defaultValue(...)` - Sets the default value for the property using various data types such as Boolean, Integer, Long, Float, Double, String, or Map.
11-
- `exampleValue(...)` - Provides an example value for illustrative purposes using various data types.
12-
- `items(...)` - Specifies the properties that define the items in the array.
10+
- `defaultValue(T... defaultValue)` - Sets the default value for the property using various data types such as Boolean, Integer, Long, Float, Double, String, or Map.
11+
- `exampleValue(T... exampleValue)` - Provides an example value for illustrative purposes using various data types.
12+
- `items(P.. properties)` - Specifies the properties that define the items in the array.
1313
- `optionsLookupDependsOn(String... optionsLookupDependsOn)` - Defines dependencies for option lookups.
1414
- `maxItems(long maxItems)` - Sets the maximum number of items allowed in the array.
1515
- `minItems(long minItems)` - Sets the minimum number of items required in the array.
1616
- `multipleValues(boolean multipleValues)` - Indicates whether the array can contain multiple values.
17-
- `options(...)` - Specifies a list of options for the property or defines a function to dynamically generate options.
17+
- `options(Option<Object>... options)` - Specifies a list of options for the property.
18+
- `options(OptionsFunction optionsFunction)` - Defines a function to dynamically generate options.
1819

1920
### Boolean Property
2021

22+
The `ModifiableBooleanProperty` class is a customizable property type designed to handle boolean values within a component.
23+
2124
- `bool(String name)` - Initializes a new `ModifiableBooleanProperty` with the specified name.
2225
- `defaultValue(boolean defaultValue)` - Sets the default value for the property.
2326
- `exampleValue(boolean exampleValue)` - Provides an example value for illustrative purposes.

0 commit comments

Comments
 (0)