Skip to content

Commit 3014923

Browse files
sbarbettsbarbett
authored
Merge pull request #11 from ultradns/feature/auth-apis
Feature/auth apis
2 parents a27d216 + 0c0e5e3 commit 3014923

File tree

5 files changed

+652
-8
lines changed

5 files changed

+652
-8
lines changed

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111
- Platform folder for system-related calls
1212
- `/version` request for testing API connectivity
1313
- `/status` request for checking status and auth
14+
- Authorization folder for auth endpoints
15+
- Includes separate requests for new token and refresh
16+
- `refreshToken` added to environment
1417

1518
## [1.1.0] - 2025-07-17
1619

‎scripts/sanitize_postman.py‎

Lines changed: 142 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
METADATA_PROPERTIES = {
1313
'_postman_id',
1414
'_exporter_id',
15+
'_collection_link',
1516
'id',
1617
'uid',
1718
'owner',
@@ -58,6 +59,123 @@ def validate_environment(data: dict) -> bool:
5859

5960
return True
6061

62+
def validate_collection_structure(data: dict) -> bool:
63+
"""Validate Postman collection structure without relying on the broken schema."""
64+
# Check required top-level fields
65+
if 'info' not in data:
66+
print("Error: Collection missing 'info' field", file=sys.stderr)
67+
return False
68+
69+
if 'item' not in data:
70+
print("Error: Collection missing 'item' field", file=sys.stderr)
71+
return False
72+
73+
if not isinstance(data['item'], list):
74+
print("Error: Collection 'item' field must be an array", file=sys.stderr)
75+
return False
76+
77+
# Validate info structure
78+
info = data['info']
79+
if not isinstance(info, dict):
80+
print("Error: Collection 'info' field must be an object", file=sys.stderr)
81+
return False
82+
83+
if 'name' not in info:
84+
print("Error: Collection info missing 'name' field", file=sys.stderr)
85+
return False
86+
87+
# Validate items recursively
88+
for i, item in enumerate(data['item']):
89+
if not validate_item_structure(item, f"item[{i}]"):
90+
return False
91+
92+
return True
93+
94+
def validate_item_structure(item: dict, path: str) -> bool:
95+
"""Validate individual item structure."""
96+
if not isinstance(item, dict):
97+
print(f"Error: {path} must be an object", file=sys.stderr)
98+
return False
99+
100+
if 'name' not in item:
101+
print(f"Error: {path} missing 'name' field", file=sys.stderr)
102+
return False
103+
104+
# Check if this is a folder (item-group) or a request (item)
105+
if 'item' in item:
106+
# This is a folder - validate nested items
107+
if not isinstance(item['item'], list):
108+
print(f"Error: {path}.item must be an array", file=sys.stderr)
109+
return False
110+
111+
for j, nested_item in enumerate(item['item']):
112+
if not validate_item_structure(nested_item, f"{path}.item[{j}]"):
113+
return False
114+
elif 'request' in item:
115+
# This is a request - validate request structure
116+
if not validate_request_structure(item['request'], f"{path}.request"):
117+
return False
118+
119+
# Validate response if present
120+
if 'response' in item:
121+
if not isinstance(item['response'], list):
122+
print(f"Error: {path}.response must be an array", file=sys.stderr)
123+
return False
124+
125+
for j, response in enumerate(item['response']):
126+
if not validate_response_structure(response, f"{path}.response[{j}]"):
127+
return False
128+
else:
129+
print(f"Error: {path} must have either 'item' (folder) or 'request' (request) field", file=sys.stderr)
130+
return False
131+
132+
return True
133+
134+
def validate_request_structure(request: dict, path: str) -> bool:
135+
"""Validate request structure."""
136+
if not isinstance(request, dict):
137+
print(f"Error: {path} must be an object", file=sys.stderr)
138+
return False
139+
140+
# Check for required fields
141+
if 'method' not in request:
142+
print(f"Error: {path} missing 'method' field", file=sys.stderr)
143+
return False
144+
145+
if 'url' not in request:
146+
print(f"Error: {path} missing 'url' field", file=sys.stderr)
147+
return False
148+
149+
# Validate URL structure
150+
url = request['url']
151+
if isinstance(url, dict):
152+
if 'raw' not in url:
153+
print(f"Error: {path}.url missing 'raw' field", file=sys.stderr)
154+
return False
155+
156+
return True
157+
158+
def validate_response_structure(response: dict, path: str) -> bool:
159+
"""Validate response structure."""
160+
if not isinstance(response, dict):
161+
print(f"Error: {path} must be an object", file=sys.stderr)
162+
return False
163+
164+
# Check for required fields
165+
if 'name' not in response:
166+
print(f"Error: {path} missing 'name' field", file=sys.stderr)
167+
return False
168+
169+
if 'status' not in response:
170+
print(f"Error: {path} missing 'status' field", file=sys.stderr)
171+
return False
172+
173+
if 'code' not in response:
174+
print(f"Error: {path} missing 'code' field", file=sys.stderr)
175+
return False
176+
177+
return True
178+
61179
def remove_metadata(data: Dict, properties: Set[str]) -> Dict:
62180
"""Recursively remove specified properties from a dictionary."""
63181
if not isinstance(data, dict):
@@ -77,17 +195,38 @@ def remove_metadata(data: Dict, properties: Set[str]) -> Dict:
77195

78196
return result
79197

198+
def fix_preview_language(data: Dict) -> Dict:
199+
"""Fix _postman_previewlanguage fields that have empty string values."""
200+
if not isinstance(data, dict):
201+
return data
202+
203+
result = {}
204+
for key, value in data.items():
205+
if key == '_postman_previewlanguage' and value == "":
206+
result[key] = None
207+
elif isinstance(value, dict):
208+
result[key] = fix_preview_language(value)
209+
elif isinstance(value, list):
210+
result[key] = [fix_preview_language(item) if isinstance(item, dict) else item for item in value]
211+
else:
212+
result[key] = value
213+
214+
return result
215+
80216
def sanitize_file(file_path: Path) -> bool:
81217
"""Sanitize a single Postman file and return True if changes were made."""
82218
try:
83219
with open(file_path, 'r', encoding='utf-8') as f:
84220
data = json.load(f)
85221

222+
# Fix _postman_previewlanguage fields first (before validation)
223+
data = fix_preview_language(data)
224+
86225
# Validate the file before sanitizing
87226
if file_path.name.endswith('.postman_collection.json'):
88-
schema = fetch_schema(COLLECTION_SCHEMA)
89-
if schema:
90-
validate(instance=data, schema=schema)
227+
# Perform basic structural validation without relying on the broken schema
228+
if not validate_collection_structure(data):
229+
return False
91230
# Set fixed collection name
92231
if 'info' in data and 'name' in data['info']:
93232
data['info']['name'] = COLLECTION_NAME

‎scripts/validate_postman.py‎

Lines changed: 141 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,33 @@ def validate_environment(data: dict) -> bool:
5454

5555
return True
5656

57+
def fix_preview_language(data: Dict) -> Dict:
58+
"""Fix _postman_previewlanguage fields that have empty string values."""
59+
if not isinstance(data, dict):
60+
return data
61+
62+
result = {}
63+
for key, value in data.items():
64+
if key == '_postman_previewlanguage' and value == "":
65+
result[key] = None
66+
elif isinstance(value, dict):
67+
result[key] = fix_preview_language(value)
68+
elif isinstance(value, list):
69+
result[key] = [fix_preview_language(item) if isinstance(item, dict) else item for item in value]
70+
else:
71+
result[key] = value
72+
73+
return result
74+
5775
def validate_file(file_path: Path) -> bool:
5876
"""Validate that a Postman file can be processed by the sanitize script."""
5977
try:
6078
with open(file_path, 'r', encoding='utf-8') as f:
6179
data = json.load(f)
6280

81+
# Fix _postman_previewlanguage fields first (before validation)
82+
data = fix_preview_language(data)
83+
6384
# Just check if it's valid JSON and can be processed
6485
if not isinstance(data, dict):
6586
print(f"Error: {file_path} is not a valid JSON object", file=sys.stderr)
@@ -69,7 +90,9 @@ def validate_file(file_path: Path) -> bool:
6990
if file_path.name.endswith('.postman_collection.json'):
7091
schema = fetch_schema(COLLECTION_SCHEMA)
7192
if schema:
72-
validate(instance=data, schema=schema)
93+
# Perform basic structural validation without relying on the broken schema
94+
if not validate_collection_structure(data):
95+
return False
7396
elif file_path.name.endswith('.postman_environment.json'):
7497
if not validate_environment(data):
7598
return False
@@ -85,6 +108,123 @@ def validate_file(file_path: Path) -> bool:
85108
print(f"Error validating {file_path}: {str(e)}", file=sys.stderr)
86109
return False
87110

111+
def validate_collection_structure(data: dict) -> bool:
112+
"""Validate Postman collection structure without relying on the broken schema."""
113+
# Check required top-level fields
114+
if 'info' not in data:
115+
print("Error: Collection missing 'info' field", file=sys.stderr)
116+
return False
117+
118+
if 'item' not in data:
119+
print("Error: Collection missing 'item' field", file=sys.stderr)
120+
return False
121+
122+
if not isinstance(data['item'], list):
123+
print("Error: Collection 'item' field must be an array", file=sys.stderr)
124+
return False
125+
126+
# Validate info structure
127+
info = data['info']
128+
if not isinstance(info, dict):
129+
print("Error: Collection 'info' field must be an object", file=sys.stderr)
130+
return False
131+
132+
if 'name' not in info:
133+
print("Error: Collection info missing 'name' field", file=sys.stderr)
134+
return False
135+
136+
# Validate items recursively
137+
for i, item in enumerate(data['item']):
138+
if not validate_item_structure(item, f"item[{i}]"):
139+
return False
140+
141+
return True
142+
143+
def validate_item_structure(item: dict, path: str) -> bool:
144+
"""Validate individual item structure."""
145+
if not isinstance(item, dict):
146+
print(f"Error: {path} must be an object", file=sys.stderr)
147+
return False
148+
149+
if 'name' not in item:
150+
print(f"Error: {path} missing 'name' field", file=sys.stderr)
151+
return False
152+
153+
# Check if this is a folder (item-group) or a request (item)
154+
if 'item' in item:
155+
# This is a folder - validate nested items
156+
if not isinstance(item['item'], list):
157+
print(f"Error: {path}.item must be an array", file=sys.stderr)
158+
return False
159+
160+
for j, nested_item in enumerate(item['item']):
161+
if not validate_item_structure(nested_item, f"{path}.item[{j}]"):
162+
return False
163+
elif 'request' in item:
164+
# This is a request - validate request structure
165+
if not validate_request_structure(item['request'], f"{path}.request"):
166+
return False
167+
168+
# Validate response if present
169+
if 'response' in item:
170+
if not isinstance(item['response'], list):
171+
print(f"Error: {path}.response must be an array", file=sys.stderr)
172+
return False
173+
174+
for j, response in enumerate(item['response']):
175+
if not validate_response_structure(response, f"{path}.response[{j}]"):
176+
return False
177+
else:
178+
print(f"Error: {path} must have either 'item' (folder) or 'request' (request) field", file=sys.stderr)
179+
return False
180+
181+
return True
182+
183+
def validate_request_structure(request: dict, path: str) -> bool:
184+
"""Validate request structure."""
185+
if not isinstance(request, dict):
186+
print(f"Error: {path} must be an object", file=sys.stderr)
187+
return False
188+
189+
# Check for required fields
190+
if 'method' not in request:
191+
print(f"Error: {path} missing 'method' field", file=sys.stderr)
192+
return False
193+
194+
if 'url' not in request:
195+
print(f"Error: {path} missing 'url' field", file=sys.stderr)
196+
return False
197+
198+
# Validate URL structure
199+
url = request['url']
200+
if isinstance(url, dict):
201+
if 'raw' not in url:
202+
print(f"Error: {path}.url missing 'raw' field", file=sys.stderr)
203+
return False
204+
205+
return True
206+
207+
def validate_response_structure(response: dict, path: str) -> bool:
208+
"""Validate response structure."""
209+
if not isinstance(response, dict):
210+
print(f"Error: {path} must be an object", file=sys.stderr)
211+
return False
212+
213+
# Check for required fields
214+
if 'name' not in response:
215+
print(f"Error: {path} missing 'name' field", file=sys.stderr)
216+
return False
217+
218+
if 'status' not in response:
219+
print(f"Error: {path} missing 'status' field", file=sys.stderr)
220+
return False
221+
222+
if 'code' not in response:
223+
print(f"Error: {path} missing 'code' field", file=sys.stderr)
224+
return False
225+
226+
return True
227+
88228
def find_postman_files(directory: Path) -> list[Path]:
89229
"""Find all Postman collection and environment files in the directory."""
90230
patterns = ['*.postman_collection.json', '*.postman_environment.json']

0 commit comments

Comments
 (0)