@@ -37,26 +37,31 @@ The server will start on `http://localhost:8000` by default.
37
37
## API Endpoints
38
38
39
39
### ` /v1/manifest/test_read `
40
+
40
41
Test reading from a specific stream in the manifest.
41
42
42
43
** POST** - Test stream reading with configurable limits for records, pages, and slices.
43
44
44
45
### ` /v1/manifest/check `
46
+
45
47
Check configuration against a manifest.
46
48
47
49
** POST** - Validates connector configuration and returns success/failure status with message.
48
50
49
51
### ` /v1/manifest/discover `
52
+
50
53
Discover streams from a manifest.
51
54
52
55
** POST** - Returns the catalog of available streams from the manifest.
53
56
54
- ### ` /v1/manifest/resolve `
57
+ ### ` /v1/manifest/resolve `
58
+
55
59
Resolve a manifest to its final configuration.
56
60
57
61
** POST** - Returns the resolved manifest without dynamic stream generation.
58
62
59
63
### ` /v1/manifest/full_resolve `
64
+
60
65
Fully resolve a manifest including dynamic streams.
61
66
62
67
** POST** - Generates dynamic streams up to specified limits and includes them in the resolved manifest.
@@ -68,6 +73,7 @@ The manifest server supports custom Python components, but this feature is **dis
68
73
### Enabling Custom Components
69
74
70
75
To allow custom Python components in your manifest files, set the environment variable:
76
+
71
77
``` bash
72
78
export AIRBYTE_ENABLE_UNSAFE_CODE=true
73
79
```
@@ -77,27 +83,33 @@ export AIRBYTE_ENABLE_UNSAFE_CODE=true
77
83
The manifest server supports optional JWT bearer token authentication:
78
84
79
85
### Configuration
86
+
80
87
Set the environment variable to enable authentication:
88
+
81
89
``` bash
82
90
export AB_JWT_SIGNATURE_SECRET=" your-jwt-secret-key"
83
91
```
84
92
85
93
### Usage
94
+
86
95
When authentication is enabled, include a valid JWT token in the Authorization header:
96
+
87
97
``` bash
88
98
curl -H " Authorization: Bearer <your-jwt-token>" \
89
99
http://localhost:8000/v1/manifest/test_read
90
100
```
91
101
92
102
### Behavior
93
- - ** Without ` AB_JWT_SIGNATURE_SECRET ` ** : All requests pass through
103
+
104
+ - ** Without ` AB_JWT_SIGNATURE_SECRET ` ** : All requests pass through
94
105
- ** With ` AB_JWT_SIGNATURE_SECRET ` ** : Requires valid JWT bearer token using HS256 algorithm
95
106
96
107
## OpenAPI Specification
97
108
98
109
The manifest server provides an OpenAPI specification for API client generation:
99
110
100
111
### Generating the OpenAPI Spec
112
+
101
113
``` bash
102
114
# Generate OpenAPI YAML (default location)
103
115
manifest-server generate-openapi
@@ -107,6 +119,7 @@ manifest-server generate-openapi --output /path/to/openapi.yaml
107
119
```
108
120
109
121
The generated OpenAPI specification is consumed by other applications and tools to:
122
+
110
123
- Generate API clients in various programming languages
111
124
- Create SDK bindings for the manifest server
112
125
- Provide API documentation and validation
@@ -115,6 +128,7 @@ The generated OpenAPI specification is consumed by other applications and tools
115
128
### Interactive API Documentation
116
129
117
130
When running, interactive API documentation is available at:
131
+
118
132
- Swagger UI: ` http://localhost:8000/docs `
119
133
- ReDoc: ` http://localhost:8000/redoc `
120
134
@@ -139,4 +153,4 @@ docker build -f airbyte_cdk/manifest_server/Dockerfile -t manifest-server .
139
153
docker run -p 8080:8080 manifest-server
140
154
```
141
155
142
- Note: The container runs on port 8080 by default.
156
+ Note: The container runs on port 8080 by default.
0 commit comments