Skip to content

Commit f5a416c

Browse files
authored
refactor: cleanup YAML tutorials and update script references (#2391)
- Removed unnecessary blank lines in tutorials - Standardized membrane.sh command usage with `./` prefix - Clarified comments and improved header examples, adding "X-Name" output logic
1 parent 882ed6e commit f5a416c

12 files changed

Lines changed: 12 additions & 19 deletions

distribution/router/README.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ If you find a bug, you can report it at:
3939
https://github.com/membrane/api-gateway/issues
4040
Please include the version of the Membrane and any details that may be necessary to reproduce the problem.
4141

42-
For professional suppor see: https://www.membrane-api.io/api-gateway-pricing.html
42+
For support see: https://www.membrane-api.io/api-gateway-pricing.html
4343
Or contact us at info@predic8.de
4444

4545

distribution/tutorials/getting-started/00-First-API.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# yaml-language-server: $schema=https://www.membrane-api.io/v7.0.0.json
32
#
43
# Membrane Tutorial: First API

distribution/tutorials/getting-started/10-Logging.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# yaml-language-server: $schema=https://www.membrane-api.io/v7.0.0.json
32
#
43
# Membrane Tutorial: Logging

distribution/tutorials/getting-started/20-Message-Flow.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# yaml-language-server: $schema=https://www.membrane-api.io/v7.0.0.json
32
#
43
# Membrane Tutorial: Message Flow
@@ -8,7 +7,7 @@
87
#
98
# 1.) Start Membrane:
109
#
11-
# membrane.sh -c 20-Message-Flow.yaml
10+
# ./membrane.sh -c 20-Message-Flow.yaml
1211
#
1312
# 2.) Call the API:
1413
#

distribution/tutorials/getting-started/30-Message-Flow2.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# yaml-language-server: $schema=https://www.membrane-api.io/v7.0.0.json
32
#
43
# Membrane Tutorial: Message Flow 2
@@ -9,7 +8,7 @@
98
#
109
# 1.) Start Membrane:
1110
#
12-
# membrane.sh -c 30-Message-Flow2.yaml
11+
# ./membrane.sh -c 30-Message-Flow2.yaml
1312
#
1413
# 2.) Call the API:
1514
#
@@ -22,6 +21,7 @@
2221
# Open in your browser: http://localhost:9000
2322
#
2423
# Click on the API 'Message Flow Logging' and view the diagram
24+
2525
api:
2626
port: 2000
2727
flow:

distribution/tutorials/getting-started/40-Basic-Path-Routing.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# yaml-language-server: $schema=https://www.membrane-api.io/v7.0.0.json
32
#
43
# Membrane Tutorial: Basic Path Routing

distribution/tutorials/getting-started/45-Admin-Web-Console.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# yaml-language-server: $schema=https://www.membrane-api.io/v7.0.0.json
32
#
43
# Membrane Tutorial: Admin Console
@@ -14,6 +13,7 @@
1413
#
1514
# Username: admin
1615
# Password: admin
16+
1717
api:
1818
port: 9000
1919
flow:

distribution/tutorials/getting-started/50-Short-Circuit.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# yaml-language-server: $schema=https://www.membrane-api.io/v7.0.0.json
32
#
43
# Membrane Tutorial: Short Circuit
Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
1-
21
# yaml-language-server: $schema=https://www.membrane-api.io/v7.0.0.json
32
#
4-
# Membrane Tutorial: SetHeader
3+
# Membrane Tutorial: setHeader
54
#
6-
# 1.) Try the requests:
5+
# 1.) Try:
76
#
87
# curl -v http://localhost:2000
9-
# curl -v -X POST http://localhost:2000
10-
#
11-
# Check the response header 'X-Powered-By' and 'X-Method'.
8+
# curl -v -d "Hugo" http://localhost:2000
129
#
10+
# Check the response headers.
1311

1412
api:
1513
port: 2000
@@ -21,5 +19,8 @@ api:
2119
- setHeader:
2220
name: X-Method
2321
value: ${method} # Variable or computed value
22+
- setHeader:
23+
name: X-Name
24+
value: Hi ${body}!
2425
- return:
2526
statusCode: 200

distribution/tutorials/getting-started/70-Template.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# yaml-language-server: $schema=https://www.membrane-api.io/v7.0.0.json
32
#
43
# Membrane Tutorial: Template

0 commit comments

Comments
 (0)