[GH-ISSUE #67] OpenAPI Specification for testing purposes (Instead of analytic tests/scripts) #9

New issue

Closed

opened 2026-10-13 19:45:30 +00:00 by bsakaguchi · 1 comment

bsakaguchi commented

2026-10-13 19:45:30 +00:00

Owner

Originally created by @Glitchy-Sheep on GitHub (Aug 31, 2025).
Original GitHub issue: https://github.com/Glitchy-Sheep/boosty-downloader/issues/67

Originally assigned to: @Glitchy-Sheep on GitHub.

The Problem

Currently, I test the API using predefined clients with configured input parameters. (see tests/analysis...)

This approach allows me to verify whether the Boosty client can handle responses correctly.
However, it is not very convenient for analyzing the responses in detail.
In general, integration tests are not meant for detailed response analysis or exploratory

Possible Solution

One approach is to define an OpenAPI specification and use it with Swagger UI. This would allow me to:

Test endpoints interactively.
Visualize and analyze API responses.
Detect changes in the original API by comparing the responses against the schema, making it clear what has changed. (Maybe we can even automate this process with some tools)

This can be done during fixing #61

Originally created by @Glitchy-Sheep on GitHub (Aug 31, 2025). Original GitHub issue: https://github.com/Glitchy-Sheep/boosty-downloader/issues/67 Originally assigned to: @Glitchy-Sheep on GitHub. # The Problem Currently, I test the API using predefined clients with configured input parameters. (see tests/analysis...) This approach allows me to verify whether the Boosty client can handle responses correctly. However, it is not very convenient for analyzing the responses in detail. In general, integration tests are not meant for detailed response analysis or exploratory # Possible Solution One approach is to define an OpenAPI specification and use it with Swagger UI. This would allow me to: * Test endpoints interactively. * Visualize and analyze API responses. * Detect changes in the original API by comparing the responses against the schema, making it clear what has changed. (Maybe we can even automate this process with some tools) This can be done during fixing #61

bsakaguchi

2026-10-13 19:45:30 +00:00

closed this issue
added the
documentation
label

bsakaguchi commented

2026-10-13 19:45:31 +00:00

Author

Owner

@Glitchy-Sheep commented on GitHub (Oct 3, 2026):

The OpenAPI schema was added in PR #203: https://github.com/Glitchy-Sheep/boosty-downloader/pull/203 (merged on 2026-09-22). It includes the observed OpenAPI 3.1 specification in docs/api/boosty-api.yaml, the task api:schema command to regenerate it from live Boosty API responses, and documentation in docs/api/README.md. Closing as completed.

@Glitchy-Sheep commented on GitHub (Oct 3, 2026): The OpenAPI schema was added in PR #203: https://github.com/Glitchy-Sheep/boosty-downloader/pull/203 (merged on 2026-09-22). It includes the observed OpenAPI 3.1 specification in `docs/api/boosty-api.yaml`, the `task api:schema` command to regenerate it from live Boosty API responses, and documentation in `docs/api/README.md`. Closing as completed.

bsakaguchi referenced this issue

2026-10-13 19:46:25 +00:00

[PR #9] [CLOSED] chore(deps-dev): Bump ruff from 0.9.9 to 0.11.2 #40