Skip to content

Consider CommonCatQueryParameters to validate query parameters #3260

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

Merged
merged 2 commits into from
Dec 6, 2024
Merged

Consider CommonCatQueryParameters to validate query parameters #3260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dae3d9f
Consider CommonCatQueryParameters to validate query parameters
pquentin Dec 6, 2024
5e9b8c9
Fix lint
pquentin Dec 6, 2024
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
36 changes: 18 additions & 18 deletions compiler/src/steps/validate-rest-spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,30 +161,30 @@ export default async function validateRestSpec (model: model.Model, jsonSpec: Ma
if (definition.body.kind !== 'no_body') {
body = Body.yesBody
}

if (definition.attachedBehaviors != null) {
for (const attachedBehavior of definition.attachedBehaviors) {
const type_ = getDefinition({
namespace: '_spec_utils',
name: attachedBehavior
})
if (
type_.kind === 'interface' &&
// allowing CommonQueryParameters too generates many errors
attachedBehavior === 'CommonCatQueryParameters'
) {
for (const prop of type_.properties) {
query.push(prop)
}
}
}
}
} else {
if (definition.properties.length > 0) {
query.push(...definition.properties)
}
}

if (Array.isArray(definition.inherits)) {
const inherits = definition.inherits.map(inherit => getDefinition(inherit.type))
for (const inherit of inherits) {
const properties = getProperties(inherit)
if (properties.path.length > 0) {
path.push(...properties.path)
}

if (properties.query.length > 0) {
query.push(...properties.query)
}

if (properties.body === Body.yesBody) {
body = properties.body
}
}
}

return { path, query, body }
}
}
146 changes: 15 additions & 131 deletions output/schema/validation-errors.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,24 +72,12 @@
},
"cat.aliases": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'v'",
"Request: missing json spec query parameter 'master_timeout'",
"request definition cat.aliases:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.allocation": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'master_timeout'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'v'",
"request definition cat.allocation:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": [
Expand All @@ -98,86 +86,56 @@
},
"cat.component_templates": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'master_timeout'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'v'",
"request definition cat.component_templates:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.count": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'v'",
"Request: query parameter 'master_timeout' does not exist in the json spec",
"request definition cat.count:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.fielddata": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'v'",
"Request: query parameter 'master_timeout' does not exist in the json spec",
"request definition cat.fielddata:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.health": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'v'",
"Request: query parameter 'master_timeout' does not exist in the json spec",
"request definition cat.health:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.help": {
"request": [
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: query parameter 'format' does not exist in the json spec",
"Request: query parameter 'h' does not exist in the json spec",
"Request: query parameter 'master_timeout' does not exist in the json spec",
"Request: query parameter 'v' does not exist in the json spec",
"request definition cat.help:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.indices": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'master_timeout'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'v'",
"request definition cat.indices:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.master": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'master_timeout'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'v'",
"request definition cat.master:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.ml_data_frame_analytics": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 'v'",
"Request: query parameter 'master_timeout' does not exist in the json spec",
"request definition cat.ml_data_frame_analytics:Request / query - Property 'h' is already defined in an ancestor class",
"request definition cat.ml_data_frame_analytics:Request / query - Property 's' is already defined in an ancestor class",
"request definition cat.ml_data_frame_analytics:Request / body - A request with inherited properties must have a PropertyBody"
Expand All @@ -186,9 +144,7 @@
},
"cat.ml_datafeeds": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 'v'",
"Request: query parameter 'master_timeout' does not exist in the json spec",
"request definition cat.ml_datafeeds:Request / query - Property 'h' is already defined in an ancestor class",
"request definition cat.ml_datafeeds:Request / query - Property 's' is already defined in an ancestor class",
"request definition cat.ml_datafeeds:Request / body - A request with inherited properties must have a PropertyBody"
Expand All @@ -197,9 +153,7 @@
},
"cat.ml_jobs": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 'v'",
"Request: query parameter 'master_timeout' does not exist in the json spec",
"request definition cat.ml_jobs:Request / query - Property 'h' is already defined in an ancestor class",
"request definition cat.ml_jobs:Request / query - Property 's' is already defined in an ancestor class",
"request definition cat.ml_jobs:Request / body - A request with inherited properties must have a PropertyBody"
Expand All @@ -208,10 +162,8 @@
},
"cat.ml_trained_models": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'help'",
"Request: query parameter 'master_timeout' does not exist in the json spec",
"Request: missing json spec query parameter 'time'",
"Request: missing json spec query parameter 'v'",
"request definition cat.ml_trained_models:Request / query - Property 'h' is already defined in an ancestor class",
"request definition cat.ml_trained_models:Request / query - Property 's' is already defined in an ancestor class",
"request definition cat.ml_trained_models:Request / body - A request with inherited properties must have a PropertyBody"
Expand All @@ -220,162 +172,94 @@
},
"cat.nodeattrs": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'master_timeout'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'v'",
"request definition cat.nodeattrs:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.nodes": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'master_timeout'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'time'",
"Request: missing json spec query parameter 'v'",
"request definition cat.nodes:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.pending_tasks": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'master_timeout'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'time'",
"Request: missing json spec query parameter 'v'",
"request definition cat.pending_tasks:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.plugins": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'master_timeout'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 'include_bootstrap'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'v'",
"request definition cat.plugins:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.recovery": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: query parameter 'master_timeout' does not exist in the json spec",
"Request: missing json spec query parameter 'index'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'time'",
"Request: missing json spec query parameter 'v'",
"request definition cat.recovery:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.repositories": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'local'",
"Request: missing json spec query parameter 'master_timeout'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'v'",
"request definition cat.repositories:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.segments": {
"request": [
"Request: query parameter 'local' does not exist in the json spec",
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'v'",
"Request: query parameter 'master_timeout' does not exist in the json spec",
"request definition cat.segments:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.shards": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'master_timeout'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'time'",
"Request: missing json spec query parameter 'v'",
"request definition cat.shards:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.snapshots": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'master_timeout'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'time'",
"Request: missing json spec query parameter 'v'",
"request definition cat.snapshots:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.tasks": {
"request": [
"Request: query parameter 'node_id' does not exist in the json spec",
"Request: missing json spec query parameter 'format'",
"Request: query parameter 'master_timeout' does not exist in the json spec",
"Request: missing json spec query parameter 'nodes'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'time'",
"Request: missing json spec query parameter 'v'",
"request definition cat.tasks:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.templates": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'master_timeout'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'v'",
"request definition cat.templates:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.thread_pool": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'master_timeout'",
"Request: missing json spec query parameter 'h'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 's'",
"Request: missing json spec query parameter 'v'",
"request definition cat.thread_pool:Request / body - A request with inherited properties must have a PropertyBody"
],
"response": []
},
"cat.transforms": {
"request": [
"Request: missing json spec query parameter 'format'",
"Request: missing json spec query parameter 'help'",
"Request: missing json spec query parameter 'v'",
"Request: query parameter 'master_timeout' does not exist in the json spec",
"request definition cat.transforms:Request / query - Property 'h' is already defined in an ancestor class",
"request definition cat.transforms:Request / query - Property 's' is already defined in an ancestor class",
"request definition cat.transforms:Request / body - A request with inherited properties must have a PropertyBody"
Expand Down
Loading