Skip to content

Add components description #2816

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

Open
christiangoerdes wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add components description #2816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
88789e0
Enhance schema generation to always reference flowParser for intercep…
christiangoerdes Feb 23, 2026
034a99a
Add components javadoc
christiangoerdes Feb 23, 2026
c93bec7
Merge branch 'master' into components-description
christiangoerdes Feb 23, 2026
fbc07f5
fix typo
christiangoerdes Feb 23, 2026
b21d1f6
Merge branch 'master' into components-description
christiangoerdes Feb 23, 2026
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
8 changes: 3 additions & 5 deletions annot/src/main/java/com/predic8/membrane/annot/generator/BeanClassGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,10 @@ protected String getClassImpl() {
* class: com.example.MyInterceptor
* scope: SINGLETON
* constructorArgs:
* - constructorArg:
* value: foo
* - value: foo
* properties:
* - property:
* name: bar
* value: baz
* - name: bar
* value: baz
*/
@MCElement(name = "bean")
public class Bean {
Expand Down
14 changes: 14 additions & 0 deletions annot/src/main/java/com/predic8/membrane/annot/generator/ComponentClassGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,20 @@ protected String getClassImpl() {

import java.util.Map;

/**
* @description Defines reusable, named components that can be referenced from other sections (e.g., via <code>$ref</code>).
* @yaml <pre><code>
* components:
* demoComponent: # id for the component
* log: {} # referenceable plugin
* ---
* api:
* port: 2000
* flow:
* - $ref: '#/components/demoComponent' # references the demo component
* </code></pre>
* @topic 1. Proxies and Flow
*/
@MCElement(name = "components", topLevel = true, component=false)
public class Components {

Expand Down
2 changes: 1 addition & 1 deletion distribution/examples/configuration/apis.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ global:
components:

demoComponent: # id for the component
log: {} # referencable plugin
log: {} # referenceable plugin

jmx: # id for the bean
bean:
Expand Down
Loading