Skip to content

chore: regenerate test model openapi - #2571

Open
cristianonicolai wants to merge 1 commit into
TimefoldAI:mainfrom
cristianonicolai:chore/openapi
Open

chore: regenerate test model openapi#2571
cristianonicolai wants to merge 1 commit into
TimefoldAI:mainfrom
cristianonicolai:chore/openapi

Conversation

@cristianonicolai

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR regenerates the test-model OpenAPI specification used by the service integration tests, reflecting the current API versioning and updated schema surface.

Changes:

  • Updates the documented API version and all endpoints from /v2-beta/... to /v1/....
  • Extends the OpenAPI schemas with new configuration fields (e.g. useTraffic, slidingWindowDuration, minimumImprovementRatio).
Suppressed comments (1)

service/test-model/src/build/openapi.json:2262

  • The minimumImprovementRatio description says it must be strictly positive and defaults to 0.0001, but the schema lacks corresponding validation/default fields, which makes the contract inconsistent for clients.
          "minimumImprovementRatio" : {
            "format" : "double",
            "description" : "Minimum ratio between current and initial improvement before the diminished returns termination kicks in. Must be strictly positive. Defaults to 0.0001 when omitted. Only takes effect when diminished returns is active (i.e. unimprovedSpentLimit and stepCountLimit are both empty).",
            "type" : "number",
            "example" : 0.0001

Comment on lines +2250 to +2257
"slidingWindowDuration" : {
"description" : "Sliding window (ISO 8601 duration format) over which score improvement is measured by the diminished returns termination. Defaults to PT30S when omitted. Only takes effect when diminished returns is active (i.e. unimprovedSpentLimit and stepCountLimit are both empty).",
"type" : "string",
"allOf" : [ {
"$ref" : "#/components/schemas/Duration"
} ],
"example" : "PT30S"
},
@sonarqubecloud

sonarqubecloud Bot commented Aug 5, 2026

Copy link
Copy Markdown

@triceo

triceo commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

@rsynek Any reason why this doesn't happen automatically?
This OpenAPI thing is starting to bother me, how much perpetual work it creates.

@rsynek

rsynek commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

I stumbled upon the OpenApi in #2545, fixed some tests and tooling in the test model and recreated the spec as a part of the PR as well.

Getting rid of the spec file altogether is a different story. I am definitely open to proposals.

@cristianonicolai

Copy link
Copy Markdown
Contributor Author

@rsynek can we get this one merged so the other PRs only update whats really related to their changes in the OpenAPI spec file?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants