Skip to content

Commit

Permalink
Update rest-api-spec (#2657)
Browse files Browse the repository at this point in the history
  • Loading branch information
pquentin authored Jun 27, 2024
1 parent 9638b2e commit 21b532f
Show file tree
Hide file tree
Showing 17 changed files with 244 additions and 41 deletions.
87 changes: 87 additions & 0 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

54 changes: 30 additions & 24 deletions output/schema/validation-errors.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 32 additions & 0 deletions specification/_json_spec/connector.sync_job_claim.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"connector.sync_job_claim": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/claim-connector-sync-job-api.html",
"description": "Claims a connector sync job."
},
"stability": "experimental",
"visibility": "public",
"headers": {
"accept": ["application/json"],
"content_type": ["application/json"]
},
"url": {
"paths": [
{
"path": "/_connector/_sync_job/{connector_sync_job_id}/_claim",
"methods": ["PUT"],
"parts": {
"connector_sync_job_id": {
"type": "string",
"description": "The unique identifier of the connector sync job to be claimed."
}
}
}
]
},
"body": {
"description": "Data to claim a sync job.",
"required": true
}
}
}
32 changes: 32 additions & 0 deletions specification/_json_spec/connector.update_features.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"connector.update_features": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-features-api.html",
"description": "Updates the connector features in the connector document."
},
"stability": "experimental",
"visibility": "public",
"headers": {
"accept": ["application/json"],
"content_type": ["application/json"]
},
"url": {
"paths": [
{
"path": "/_connector/{connector_id}/_features",
"methods": ["PUT"],
"parts": {
"connector_id": {
"type": "string",
"description": "The unique identifier of the connector to be updated."
}
}
}
]
},
"body": {
"description": "An object containing the connector's features definition.",
"required": true
}
}
}
6 changes: 6 additions & 0 deletions specification/_json_spec/features.reset_features.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@
"methods": ["POST"]
}
]
},
"params": {
"master_timeout": {
"type": "time",
"description": "Explicit operation timeout for connection to master node"
}
}
}
}
2 changes: 1 addition & 1 deletion specification/_json_spec/inference.delete.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
},
"force": {
"type": "boolean",
"description": "True if the endpoint should be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields).",
"description": "If true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields).",
"required": false
}
}
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/ml.get_categories.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
}
},
{
"path": "/_ml/anomaly_detectors/{job_id}/results/categories/",
"path": "/_ml/anomaly_detectors/{job_id}/results/categories",
"methods": ["GET", "POST"],
"parts": {
"job_id": {
Expand Down
6 changes: 3 additions & 3 deletions specification/_json_spec/query_rule.delete.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"query_rule.delete": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-rule.html",
"description": "Deletes an individual query rule within a query ruleset."
"description": "Deletes an individual query rule within a ruleset."
},
"stability": "stable",
"visibility": "public",
Expand All @@ -17,11 +17,11 @@
"parts": {
"ruleset_id": {
"type": "string",
"description": "The unique identifier of the query ruleset containing the rule to delete"
"description": "The unique identifier of the query ruleset this rule exists in"
},
"rule_id": {
"type": "string",
"description": "The unique identifier of the query rule to delete"
"description": "The unique identifier of the rule to delete."
}
}
}
Expand Down
6 changes: 3 additions & 3 deletions specification/_json_spec/query_rule.get.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"query_rule.get": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-rule.html",
"description": "Returns the details about an individual query rule within a query ruleset."
"description": "Returns the details about an individual query rule within a ruleset."
},
"stability": "stable",
"visibility": "public",
Expand All @@ -17,11 +17,11 @@
"parts": {
"ruleset_id": {
"type": "string",
"description": "The unique identifier of the query ruleset"
"description": "The unique identifier of the query ruleset the rule exists within"
},
"rule_id": {
"type": "string",
"description": "The unique identifier of the query rule"
"description": "The unique identifier of the rule to be retrieved."
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions specification/_json_spec/query_rule.put.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"query_rule.put": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-rule.html",
"description": "Creates or updates an individual query rule within a query ruleset."
"description": "Creates or updates a query rule within a ruleset."
},
"stability": "stable",
"visibility": "public",
Expand All @@ -18,18 +18,18 @@
"parts": {
"ruleset_id": {
"type": "string",
"description": "The unique identifier of the ruleset containing the rule to be created or updated."
"description": "The unique identifier of the ruleset this rule should be added to. The ruleset will be created if it does not exist."
},
"rule_id": {
"type": "string",
"description": "The unique identifier of the query rule to be created or updated."
"description": "The unique identifier of the rule to be created or updated."
}
}
}
]
},
"body": {
"description": "The query rule",
"description": "The query rule configuration, including the type of rule, the criteria to match the rule, and the action that should be taken if the rule matches.",
"required": true
}
}
Expand Down
Loading

0 comments on commit 21b532f

Please sign in to comment.