Skip to content

Commit 028965c

Browse files
chore: update mock server docs
1 parent b74b93b commit 028965c

4 files changed

Lines changed: 39 additions & 40 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,7 @@ $ pip install ./path-to-wheel-file.whl
8888
Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
8989

9090
```sh
91-
# you will need npm installed
92-
$ npx prism mock path/to/your/openapi.yml
91+
$ ./scripts/mock
9392
```
9493

9594
```sh

tests/api_resources/beta/test_findall.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -296,15 +296,15 @@ def test_path_params_enrich(self, client: Parallel) -> None:
296296
},
297297
)
298298

299-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
299+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
300300
@parametrize
301301
def test_method_events(self, client: Parallel) -> None:
302302
findall_stream = client.beta.findall.events(
303303
findall_id="findall_id",
304304
)
305305
findall_stream.response.close()
306306

307-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
307+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
308308
@parametrize
309309
def test_method_events_with_all_params(self, client: Parallel) -> None:
310310
findall_stream = client.beta.findall.events(
@@ -315,7 +315,7 @@ def test_method_events_with_all_params(self, client: Parallel) -> None:
315315
)
316316
findall_stream.response.close()
317317

318-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
318+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
319319
@parametrize
320320
def test_raw_response_events(self, client: Parallel) -> None:
321321
response = client.beta.findall.with_raw_response.events(
@@ -326,7 +326,7 @@ def test_raw_response_events(self, client: Parallel) -> None:
326326
stream = response.parse()
327327
stream.close()
328328

329-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
329+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
330330
@parametrize
331331
def test_streaming_response_events(self, client: Parallel) -> None:
332332
with client.beta.findall.with_streaming_response.events(
@@ -340,7 +340,7 @@ def test_streaming_response_events(self, client: Parallel) -> None:
340340

341341
assert cast(Any, response.is_closed) is True
342342

343-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
343+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
344344
@parametrize
345345
def test_path_params_events(self, client: Parallel) -> None:
346346
with pytest.raises(ValueError, match=r"Expected a non-empty value for `findall_id` but received ''"):
@@ -811,15 +811,15 @@ async def test_path_params_enrich(self, async_client: AsyncParallel) -> None:
811811
},
812812
)
813813

814-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
814+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
815815
@parametrize
816816
async def test_method_events(self, async_client: AsyncParallel) -> None:
817817
findall_stream = await async_client.beta.findall.events(
818818
findall_id="findall_id",
819819
)
820820
await findall_stream.response.aclose()
821821

822-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
822+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
823823
@parametrize
824824
async def test_method_events_with_all_params(self, async_client: AsyncParallel) -> None:
825825
findall_stream = await async_client.beta.findall.events(
@@ -830,7 +830,7 @@ async def test_method_events_with_all_params(self, async_client: AsyncParallel)
830830
)
831831
await findall_stream.response.aclose()
832832

833-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
833+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
834834
@parametrize
835835
async def test_raw_response_events(self, async_client: AsyncParallel) -> None:
836836
response = await async_client.beta.findall.with_raw_response.events(
@@ -841,7 +841,7 @@ async def test_raw_response_events(self, async_client: AsyncParallel) -> None:
841841
stream = await response.parse()
842842
await stream.close()
843843

844-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
844+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
845845
@parametrize
846846
async def test_streaming_response_events(self, async_client: AsyncParallel) -> None:
847847
async with async_client.beta.findall.with_streaming_response.events(
@@ -855,7 +855,7 @@ async def test_streaming_response_events(self, async_client: AsyncParallel) -> N
855855

856856
assert cast(Any, response.is_closed) is True
857857

858-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
858+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
859859
@parametrize
860860
async def test_path_params_events(self, async_client: AsyncParallel) -> None:
861861
with pytest.raises(ValueError, match=r"Expected a non-empty value for `findall_id` but received ''"):

tests/api_resources/beta/test_task_group.py

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -211,15 +211,15 @@ def test_path_params_add_runs(self, client: Parallel) -> None:
211211
],
212212
)
213213

214-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
214+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
215215
@parametrize
216216
def test_method_events(self, client: Parallel) -> None:
217217
task_group_stream = client.beta.task_group.events(
218218
task_group_id="taskgroup_id",
219219
)
220220
task_group_stream.response.close()
221221

222-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
222+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
223223
@parametrize
224224
def test_method_events_with_all_params(self, client: Parallel) -> None:
225225
task_group_stream = client.beta.task_group.events(
@@ -229,7 +229,7 @@ def test_method_events_with_all_params(self, client: Parallel) -> None:
229229
)
230230
task_group_stream.response.close()
231231

232-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
232+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
233233
@parametrize
234234
def test_raw_response_events(self, client: Parallel) -> None:
235235
response = client.beta.task_group.with_raw_response.events(
@@ -240,7 +240,7 @@ def test_raw_response_events(self, client: Parallel) -> None:
240240
stream = response.parse()
241241
stream.close()
242242

243-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
243+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
244244
@parametrize
245245
def test_streaming_response_events(self, client: Parallel) -> None:
246246
with client.beta.task_group.with_streaming_response.events(
@@ -254,23 +254,23 @@ def test_streaming_response_events(self, client: Parallel) -> None:
254254

255255
assert cast(Any, response.is_closed) is True
256256

257-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
257+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
258258
@parametrize
259259
def test_path_params_events(self, client: Parallel) -> None:
260260
with pytest.raises(ValueError, match=r"Expected a non-empty value for `task_group_id` but received ''"):
261261
client.beta.task_group.with_raw_response.events(
262262
task_group_id="",
263263
)
264264

265-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
265+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
266266
@parametrize
267267
def test_method_get_runs(self, client: Parallel) -> None:
268268
task_group_stream = client.beta.task_group.get_runs(
269269
task_group_id="taskgroup_id",
270270
)
271271
task_group_stream.response.close()
272272

273-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
273+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
274274
@parametrize
275275
def test_method_get_runs_with_all_params(self, client: Parallel) -> None:
276276
task_group_stream = client.beta.task_group.get_runs(
@@ -282,7 +282,7 @@ def test_method_get_runs_with_all_params(self, client: Parallel) -> None:
282282
)
283283
task_group_stream.response.close()
284284

285-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
285+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
286286
@parametrize
287287
def test_raw_response_get_runs(self, client: Parallel) -> None:
288288
response = client.beta.task_group.with_raw_response.get_runs(
@@ -293,7 +293,7 @@ def test_raw_response_get_runs(self, client: Parallel) -> None:
293293
stream = response.parse()
294294
stream.close()
295295

296-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
296+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
297297
@parametrize
298298
def test_streaming_response_get_runs(self, client: Parallel) -> None:
299299
with client.beta.task_group.with_streaming_response.get_runs(
@@ -307,7 +307,7 @@ def test_streaming_response_get_runs(self, client: Parallel) -> None:
307307

308308
assert cast(Any, response.is_closed) is True
309309

310-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
310+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
311311
@parametrize
312312
def test_path_params_get_runs(self, client: Parallel) -> None:
313313
with pytest.raises(ValueError, match=r"Expected a non-empty value for `task_group_id` but received ''"):
@@ -511,15 +511,15 @@ async def test_path_params_add_runs(self, async_client: AsyncParallel) -> None:
511511
],
512512
)
513513

514-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
514+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
515515
@parametrize
516516
async def test_method_events(self, async_client: AsyncParallel) -> None:
517517
task_group_stream = await async_client.beta.task_group.events(
518518
task_group_id="taskgroup_id",
519519
)
520520
await task_group_stream.response.aclose()
521521

522-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
522+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
523523
@parametrize
524524
async def test_method_events_with_all_params(self, async_client: AsyncParallel) -> None:
525525
task_group_stream = await async_client.beta.task_group.events(
@@ -529,7 +529,7 @@ async def test_method_events_with_all_params(self, async_client: AsyncParallel)
529529
)
530530
await task_group_stream.response.aclose()
531531

532-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
532+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
533533
@parametrize
534534
async def test_raw_response_events(self, async_client: AsyncParallel) -> None:
535535
response = await async_client.beta.task_group.with_raw_response.events(
@@ -540,7 +540,7 @@ async def test_raw_response_events(self, async_client: AsyncParallel) -> None:
540540
stream = await response.parse()
541541
await stream.close()
542542

543-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
543+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
544544
@parametrize
545545
async def test_streaming_response_events(self, async_client: AsyncParallel) -> None:
546546
async with async_client.beta.task_group.with_streaming_response.events(
@@ -554,23 +554,23 @@ async def test_streaming_response_events(self, async_client: AsyncParallel) -> N
554554

555555
assert cast(Any, response.is_closed) is True
556556

557-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
557+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
558558
@parametrize
559559
async def test_path_params_events(self, async_client: AsyncParallel) -> None:
560560
with pytest.raises(ValueError, match=r"Expected a non-empty value for `task_group_id` but received ''"):
561561
await async_client.beta.task_group.with_raw_response.events(
562562
task_group_id="",
563563
)
564564

565-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
565+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
566566
@parametrize
567567
async def test_method_get_runs(self, async_client: AsyncParallel) -> None:
568568
task_group_stream = await async_client.beta.task_group.get_runs(
569569
task_group_id="taskgroup_id",
570570
)
571571
await task_group_stream.response.aclose()
572572

573-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
573+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
574574
@parametrize
575575
async def test_method_get_runs_with_all_params(self, async_client: AsyncParallel) -> None:
576576
task_group_stream = await async_client.beta.task_group.get_runs(
@@ -582,7 +582,7 @@ async def test_method_get_runs_with_all_params(self, async_client: AsyncParallel
582582
)
583583
await task_group_stream.response.aclose()
584584

585-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
585+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
586586
@parametrize
587587
async def test_raw_response_get_runs(self, async_client: AsyncParallel) -> None:
588588
response = await async_client.beta.task_group.with_raw_response.get_runs(
@@ -593,7 +593,7 @@ async def test_raw_response_get_runs(self, async_client: AsyncParallel) -> None:
593593
stream = await response.parse()
594594
await stream.close()
595595

596-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
596+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
597597
@parametrize
598598
async def test_streaming_response_get_runs(self, async_client: AsyncParallel) -> None:
599599
async with async_client.beta.task_group.with_streaming_response.get_runs(
@@ -607,7 +607,7 @@ async def test_streaming_response_get_runs(self, async_client: AsyncParallel) ->
607607

608608
assert cast(Any, response.is_closed) is True
609609

610-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
610+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
611611
@parametrize
612612
async def test_path_params_get_runs(self, async_client: AsyncParallel) -> None:
613613
with pytest.raises(ValueError, match=r"Expected a non-empty value for `task_group_id` but received ''"):

tests/api_resources/beta/test_task_run.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -94,15 +94,15 @@ def test_streaming_response_create(self, client: Parallel) -> None:
9494

9595
assert cast(Any, response.is_closed) is True
9696

97-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
97+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
9898
@parametrize
9999
def test_method_events(self, client: Parallel) -> None:
100100
task_run_stream = client.beta.task_run.events(
101101
"run_id",
102102
)
103103
task_run_stream.response.close()
104104

105-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
105+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
106106
@parametrize
107107
def test_raw_response_events(self, client: Parallel) -> None:
108108
response = client.beta.task_run.with_raw_response.events(
@@ -113,7 +113,7 @@ def test_raw_response_events(self, client: Parallel) -> None:
113113
stream = response.parse()
114114
stream.close()
115115

116-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
116+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
117117
@parametrize
118118
def test_streaming_response_events(self, client: Parallel) -> None:
119119
with client.beta.task_run.with_streaming_response.events(
@@ -127,7 +127,7 @@ def test_streaming_response_events(self, client: Parallel) -> None:
127127

128128
assert cast(Any, response.is_closed) is True
129129

130-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
130+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
131131
@parametrize
132132
def test_path_params_events(self, client: Parallel) -> None:
133133
with pytest.raises(ValueError, match=r"Expected a non-empty value for `run_id` but received ''"):
@@ -263,15 +263,15 @@ async def test_streaming_response_create(self, async_client: AsyncParallel) -> N
263263

264264
assert cast(Any, response.is_closed) is True
265265

266-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
266+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
267267
@parametrize
268268
async def test_method_events(self, async_client: AsyncParallel) -> None:
269269
task_run_stream = await async_client.beta.task_run.events(
270270
"run_id",
271271
)
272272
await task_run_stream.response.aclose()
273273

274-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
274+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
275275
@parametrize
276276
async def test_raw_response_events(self, async_client: AsyncParallel) -> None:
277277
response = await async_client.beta.task_run.with_raw_response.events(
@@ -282,7 +282,7 @@ async def test_raw_response_events(self, async_client: AsyncParallel) -> None:
282282
stream = await response.parse()
283283
await stream.close()
284284

285-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
285+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
286286
@parametrize
287287
async def test_streaming_response_events(self, async_client: AsyncParallel) -> None:
288288
async with async_client.beta.task_run.with_streaming_response.events(
@@ -296,7 +296,7 @@ async def test_streaming_response_events(self, async_client: AsyncParallel) -> N
296296

297297
assert cast(Any, response.is_closed) is True
298298

299-
@pytest.mark.skip(reason="Prism doesn't support text/event-stream responses")
299+
@pytest.mark.skip(reason="Mock server doesn't support text/event-stream responses")
300300
@parametrize
301301
async def test_path_params_events(self, async_client: AsyncParallel) -> None:
302302
with pytest.raises(ValueError, match=r"Expected a non-empty value for `run_id` but received ''"):

0 commit comments

Comments
 (0)