Skip to content

Commit c331849

Browse files
authored
Example docsadd anchor link in examples (#2170)
* add anchor link in examples * add anchor link in examples/graphql * edit heading in access-control-list
1 parent 6ac7849 commit c331849

File tree

13 files changed

+30
-19
lines changed

13 files changed

+30
-19
lines changed

distribution/examples/README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Have **10 minutes** and want to solve a task with Membrane? These hands-on examples are ready to run and explore.
44

5-
## [Deployment and Installation](deployment)
5+
## [Deployment and Installation](deployment#deployment-and-installation)
66

77
* Docker
88
* As Windows service
@@ -12,7 +12,7 @@ Have **10 minutes** and want to solve a task with Membrane? These hands-on examp
1212
* Deploy APIs from OpenAPI definitions
1313
* Validate requests, responses, and security
1414

15-
## [API Traffic Routing](routing-traffic)
15+
## [API Traffic Routing](routing-traffic#api-traffic-routing)
1616

1717
* Rewriting API URLs
1818
* Shadow traffic to other environments (e.g., TEST)
@@ -21,13 +21,13 @@ Have **10 minutes** and want to solve a task with Membrane? These hands-on examp
2121
* Internal routing
2222
* Throttle API traffic
2323

24-
## [Scripting](scripting)
24+
## [Scripting](scripting#scripting)
2525

2626
* Use Groovy and JavaScript for scripting
2727

28-
Samples of scripting with JSONPath, XPath and the expression language you can find in the [templating](templating) or [orchestration](orchestration) folders.
28+
Samples of scripting with JSONPath, XPath and the expression language you can find in the [templating](templating#template---transforming-messages) or [orchestration](orchestration#orchestration) folders.
2929

30-
## [Security](security)
30+
## [Security](security#samples-for-api-security-with-membrane-api-gateway)
3131

3232
* Authentication and authorization with JWT, OAuth2 and OIDC
3333
* **API keys** and Basic Authentication
@@ -37,20 +37,20 @@ Samples of scripting with JSONPath, XPath and the expression language you can fi
3737
* IP and host-based **Access Control Lists**
3838
* Form login
3939
* NTLM
40-
* [Rate limiting](rate-limiting)
40+
* [Rate limiting](rate-limiting#rate-limiter)
4141

42-
### [Message Validation](validation)
42+
### [Message Validation](validation#message-validation)
4343

4444
* HTML-form validation
4545
* JSON-Schema validation
4646

47-
## [Orchestration](orchestration)
47+
## [Orchestration](orchestration#orchestration)
4848

4949
* Authentication with external APIs
5050
* Samples for GET and POST callouts
5151
* Use for-loops for multiple callouts
5252

53-
## [Extending Membrane](extending-membrane)
53+
## [Extending Membrane](extending-membrane#configuration-and-extension-examples-for-membrane-api-gateway)
5454

5555
* Use `if` conditions to modify behavior
5656
* Externalize configuration with **properties** and **environment variables**
@@ -62,21 +62,21 @@ Samples of scripting with JSONPath, XPath and the expression language you can fi
6262

6363

6464

65-
## [Message Transformation](message-transformation)
65+
## [Message Transformation](message-transformation#message-transformation)
6666

6767
* Create dynamic API responses using [templates](templating) (JSON, XML, Text)
6868
* Generic JSON to XML and XML to JSON
6969
* Replacing with Regex
7070
* Transformation with Javascript
7171

72-
## [Legacy Integration for XML and Web Services](web-services-soap)
72+
## [Legacy Integration for XML and Web Services](web-services-soap#web-services-soap)
7373

74-
### [XML](xml)
74+
### [XML](xml#xml)
7575

7676
* XML validation and XSLT transformation
7777
* Create XML plugins with DOM or StAX
7878

79-
### [Web Services with SOAP](web-services-soap)
79+
### [Web Services with SOAP](web-services-soap#web-services-soap)
8080

8181
* Validation of SOAP messages against WSDL
8282
* REST to SOAP conversion and migration
@@ -87,24 +87,24 @@ Samples of scripting with JSONPath, XPath and the expression language you can fi
8787

8888
## Other Protocols
8989

90-
### [GraphQL](graphql)
90+
### [GraphQL](graphql#graphql)
9191

9292
* Validate GraphQL requests
9393

94-
### [Web Sockets](websockets)
94+
### [Web Sockets](websockets#websockets)
9595

9696
* STOMP over Websockets
9797
* Writing own Web Sockets plugins
9898

9999
## Operation
100100

101-
### [YAML Configuration](yaml-configuration)
101+
### [YAML Configuration](yaml-configuration#yaml-configuration)
102102

103-
### [Monitoring and Tracing](monitoring-tracing)
103+
### [Monitoring and Tracing](monitoring-tracing#monitoring-tracing)
104104

105105
* OpenTelemetry & Prometheus
106106

107-
### [Logging](logging)
107+
### [Logging](logging#logging-requests-and-responses)
108108

109109
* Access log
110110
* Log into console, CSV or databases
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Deployment and Installation
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# GraphQL
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Message Transformation
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Monitoring Tracing
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Orchestration
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# API Traffic Routing
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Scripting

distribution/examples/security/access-control-list/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### ACCESS CONTROL INTERCEPTOR
1+
# ACCESS CONTROL INTERCEPTOR
22

33
With the AccessControlInterceptor you can restrict access to services and resources.
44

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Message Validation

0 commit comments

Comments
 (0)