Skip to content

[FLINK-39422] [REST][docs] Fix OpenAPI spec for SlotSharingGroupId, MetricCollectionResponseBody, and SerializedThrowable custom serializers #27903

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nikhilsu wants to merge 10 commits into
base: master
Choose a base branch
from
Open

[FLINK-39422] [REST][docs] Fix OpenAPI spec for SlotSharingGroupId, MetricCollectionResponseBody, and SerializedThrowable custom serializers #27903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1dbc4a9
[hotfix][docs] Add SlotSharingGroupId to OpenAPI spec generator ID sc…
nikhilsu Apr 8, 2026
f056835
Regen docs
nikhilsu Apr 8, 2026
baabd9a
Override MetricCollectionSchema
nikhilsu Apr 8, 2026
cbe596a
Regen Docs
nikhilsu Apr 8, 2026
4930eac
Add spec override for SerializedThrowable
nikhilsu Apr 8, 2026
1f22ed5
Refactor MetricCollectionResponseBody to inherit from an ArrayList
nikhilsu Apr 12, 2026
46d50b0
Regen docs
nikhilsu Apr 12, 2026
acdfde9
Minor tweaks
nikhilsu Apr 12, 2026
27a3ea4
Update AggregatedMetricsResponseBody to extend from ArrayList
nikhilsu Apr 15, 2026
a5e9660
Randomize
nikhilsu Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
186 changes: 176 additions & 10 deletions docs/layouts/shortcodes/generated/rest_v1_dispatcher.html
View file
Open in desktop
Copy link
Copy Markdown
Author

@nikhilsu nikhilsu Apr 12, 2026

Choose a reason for hiding this comment

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

FYI: changes to *.html and *.yml were made as part of running ./mvnw package -Dgenerate-rest-docs -pl flink-docs -am -nsu -DskipTests 2>&1

Original file line number Diff line number Diff line change
Expand Up @@ -1354,7 +1354,20 @@
<details>
<summary>Response</summary>
<pre><code>{
"type" : "any"
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:Metric",
"properties" : {
"id" : {
"type" : "string",
"required" : true
},
"value" : {
"type" : "string"
}
}
}
}</code></pre>
</label>
</td>
Expand Down Expand Up @@ -1505,7 +1518,32 @@
<details>
<summary>Response</summary>
<pre><code>{
"type" : "any"
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:AggregatedMetric",
"properties" : {
"avg" : {
"type" : "number"
},
"id" : {
"type" : "string",
"required" : true
},
"max" : {
"type" : "number"
},
"min" : {
"type" : "number"
},
"skew" : {
"type" : "number"
},
"sum" : {
"type" : "number"
}
}
}
}</code></pre>
</label>
</td>
Expand Down Expand Up @@ -3444,7 +3482,20 @@
<details>
<summary>Response</summary>
<pre><code>{
"type" : "any"
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:Metric",
"properties" : {
"id" : {
"type" : "string",
"required" : true
},
"value" : {
"type" : "string"
}
}
}
}</code></pre>
</label>
</td>
Expand Down Expand Up @@ -5110,7 +5161,20 @@
<details>
<summary>Response</summary>
<pre><code>{
"type" : "any"
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:Metric",
"properties" : {
"id" : {
"type" : "string",
"required" : true
},
"value" : {
"type" : "string"
}
}
}
}</code></pre>
</label>
</td>
Expand Down Expand Up @@ -5165,7 +5229,20 @@
<details>
<summary>Response</summary>
<pre><code>{
"type" : "any"
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:Metric",
"properties" : {
"id" : {
"type" : "string",
"required" : true
},
"value" : {
"type" : "string"
}
}
}
}</code></pre>
</label>
</td>
Expand Down Expand Up @@ -5312,7 +5389,32 @@
<details>
<summary>Response</summary>
<pre><code>{
"type" : "any"
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:AggregatedMetric",
"properties" : {
"avg" : {
"type" : "number"
},
"id" : {
"type" : "string",
"required" : true
},
"max" : {
"type" : "number"
},
"min" : {
"type" : "number"
},
"skew" : {
"type" : "number"
},
"sum" : {
"type" : "number"
}
}
}
}</code></pre>
</label>
</td>
Expand Down Expand Up @@ -5704,7 +5806,20 @@
<details>
<summary>Response</summary>
<pre><code>{
"type" : "any"
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:Metric",
"properties" : {
"id" : {
"type" : "string",
"required" : true
},
"value" : {
"type" : "string"
}
}
}
}</code></pre>
</label>
</td>
Expand Down Expand Up @@ -5984,7 +6099,20 @@
<details>
<summary>Response</summary>
<pre><code>{
"type" : "any"
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:Metric",
"properties" : {
"id" : {
"type" : "string",
"required" : true
},
"value" : {
"type" : "string"
}
}
}
}</code></pre>
</label>
</td>
Expand Down Expand Up @@ -6373,7 +6501,32 @@
<details>
<summary>Response</summary>
<pre><code>{
"type" : "any"
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:AggregatedMetric",
"properties" : {
"avg" : {
"type" : "number"
},
"id" : {
"type" : "string",
"required" : true
},
"max" : {
"type" : "number"
},
"min" : {
"type" : "number"
},
"skew" : {
"type" : "number"
},
"sum" : {
"type" : "number"
}
}
}
}</code></pre>
</label>
</td>
Expand Down Expand Up @@ -6748,7 +6901,20 @@
<details>
<summary>Response</summary>
<pre><code>{
"type" : "any"
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:Metric",
"properties" : {
"id" : {
"type" : "string",
"required" : true
},
"value" : {
"type" : "string"
}
}
}
}</code></pre>
</label>
</td>
Expand Down
Loading