Skip to content
This repository was archived by the owner on Feb 13, 2024. It is now read-only.

Commit 3fdd279

Browse files
author
[btpsa bot] docu generation
committed
[btpsa bot] Generate parameter documentation
1 parent e9e2cd9 commit 3fdd279

7 files changed

+13
-54
lines changed

‎docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-authorities-items-0.md

-13
This file was deleted.

‎docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-authorities.md

-5
This file was deleted.

‎docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-queuerules.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66

77
| Property | Type | Required | Nullable | Defined by |
88
| :---------------------------------- | :------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9-
| [publishFilter](#publishfilter) | `array` | Required | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-queuerules-properties-publishfilter.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/rules/properties/queueRules/properties/publishFilter") |
10-
| [subscribeFilter](#subscribefilter) | `array` | Required | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-queuerules-properties-subscribefilter.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/rules/properties/queueRules/properties/subscribeFilter") |
9+
| [publishFilter](#publishfilter) | `array` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-queuerules-properties-publishfilter.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/rules/properties/queueRules/properties/publishFilter") |
10+
| [subscribeFilter](#subscribefilter) | `array` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-queuerules-properties-subscribefilter.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/rules/properties/queueRules/properties/subscribeFilter") |
1111

1212
## publishFilter
1313

1414

1515

1616
`publishFilter`
1717

18-
* is required
18+
* is optional
1919

2020
* Type: an array where each item follows the corresponding schema in the following list:
2121

@@ -37,7 +37,7 @@ an array where each item follows the corresponding schema in the following list:
3737

3838
`subscribeFilter`
3939

40-
* is required
40+
* is optional
4141

4242
* Type: an array where each item follows the corresponding schema in the following list:
4343

‎docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-topicrules.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66

77
| Property | Type | Required | Nullable | Defined by |
88
| :---------------------------------- | :------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9-
| [publishFilter](#publishfilter) | `array` | Required | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-topicrules-properties-publishfilter.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/rules/properties/topicRules/properties/publishFilter") |
10-
| [subscribeFilter](#subscribefilter) | `array` | Required | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-topicrules-properties-subscribefilter.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/rules/properties/topicRules/properties/subscribeFilter") |
9+
| [publishFilter](#publishfilter) | `array` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-topicrules-properties-publishfilter.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/rules/properties/topicRules/properties/publishFilter") |
10+
| [subscribeFilter](#subscribefilter) | `array` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-topicrules-properties-subscribefilter.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/rules/properties/topicRules/properties/subscribeFilter") |
1111

1212
## publishFilter
1313

1414

1515

1616
`publishFilter`
1717

18-
* is required
18+
* is optional
1919

2020
* Type: an array where each item follows the corresponding schema in the following list:
2121

@@ -37,7 +37,7 @@ an array where each item follows the corresponding schema in the following list:
3737

3838
`subscribeFilter`
3939

40-
* is required
40+
* is optional
4141

4242
* Type: an array where each item follows the corresponding schema in the following list:
4343

‎docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66

77
| Property | Type | Required | Nullable | Defined by |
88
| :------------------------ | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9-
| [queueRules](#queuerules) | `object` | Required | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-queuerules.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/rules/properties/queueRules") |
10-
| [topicRules](#topicrules) | `object` | Required | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-topicrules.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/rules/properties/topicRules") |
9+
| [queueRules](#queuerules) | `object` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-queuerules.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/rules/properties/queueRules") |
10+
| [topicRules](#topicrules) | `object` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-topicrules.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/rules/properties/topicRules") |
1111

1212
## queueRules
1313

1414

1515

1616
`queueRules`
1717

18-
* is required
18+
* is optional
1919

2020
* Type: `object` ([Details](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-queuerules.md))
2121

@@ -33,7 +33,7 @@
3333

3434
`topicRules`
3535

36-
* is required
36+
* is optional
3737

3838
* Type: `object` ([Details](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-rules-properties-topicrules.md))
3939

‎docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters.md

-23
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66

77
| Property | Type | Required | Nullable | Defined by |
88
| :-------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9-
| [authorities](#authorities) | `array` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-authorities.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/authorities") |
109
| [emname](#emname) | `string` | Required | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-emname.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/emname") |
1110
| [namespace](#namespace) | `string` | Required | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-namespace.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/namespace") |
1211
| [options](#options) | `object` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-options.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/options") |
@@ -15,28 +14,6 @@
1514
| [version](#version) | `string` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-version.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/version") |
1615
| [xs-security](#xs-security) | `object` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-xs-security.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/xs-security") |
1716

18-
## authorities
19-
20-
21-
22-
`authorities`
23-
24-
* is optional
25-
26-
* Type: an array where each item follows the corresponding schema in the following list:
27-
28-
1. [Untitled string in JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-authorities-items-0.md "check type definition")
29-
30-
* cannot be null
31-
32-
* defined in: [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-authorities.md "undefined#/properties/services/items/allOf/1/then/allOf/39/then/allOf/0/then/properties/parameters/properties/authorities")
33-
34-
### authorities Type
35-
36-
an array where each item follows the corresponding schema in the following list:
37-
38-
1. [Untitled string in JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-39-then-allof-0-then-properties-parameters-properties-authorities-items-0.md "check type definition")
39-
4017
## emname
4118

4219
It specifies the name of the message client. emname is used in the Event Mesh business application to identify message clients with ease.

0 commit comments

Comments
 (0)