[Security Solution] Add missing Detections API OpenAPI specs #186764
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| /* | ||
| * NOTICE: Do not edit this file manually. | ||
| * This file is automatically generated by the OpenAPI Generator, @kbn/openapi-generator. | ||
| * | ||
| * info: | ||
| * title: Read privileges API endpoint | ||
| * version: 2023-10-31 | ||
| */ | ||
|
|
||
| import { z } from 'zod'; | ||
|
|
||
| export type GetPrivilegesResponse = z.infer<typeof GetPrivilegesResponse>; | ||
| export const GetPrivilegesResponse = z.object({ | ||
| is_authenticated: z.boolean(), | ||
| has_encryption_key: z.boolean(), | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| openapi: 3.0.0 | ||
| info: | ||
| title: Read privileges API endpoint | ||
| version: '2023-10-31' | ||
| paths: | ||
| /api/detection_engine/privileges: | ||
| get: | ||
| x-labels: [serverless, ess] | ||
| operationId: GetPrivileges | ||
| x-codegen-enabled: true | ||
| summary: Returns user privileges for the Kibana space | ||
| description: | | ||
| Retrieves whether or not the user is authenticated, and the user's Kibana | ||
| space and index privileges, which determine if the user can create an | ||
| index for the Elastic Security alerts generated by | ||
| detection engine rules. | ||
| tags: | ||
| - Privileges API | ||
| responses: | ||
| 200: | ||
| description: Successful response | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: object | ||
| properties: | ||
| is_authenticated: | ||
| type: boolean | ||
| has_encryption_key: | ||
| type: boolean | ||
| required: [is_authenticated, has_encryption_key] | ||
| 401: | ||
| description: Unsuccessful authentication response | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../../../model/error_responses.schema.yaml#/components/schemas/PlatformErrorResponse' | ||
| 500: | ||
| description: Internal server error response | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../../../model/error_responses.schema.yaml#/components/schemas/SiemErrorResponse' | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,4 +5,4 @@ | |
| * 2.0. | ||
| */ | ||
|
|
||
| export * from './rule_preview.gen'; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| /* | ||
| * NOTICE: Do not edit this file manually. | ||
| * This file is automatically generated by the OpenAPI Generator, @kbn/openapi-generator. | ||
| * | ||
| * info: | ||
| * title: Rule preview API endpoint | ||
| * version: 2023-10-31 | ||
| */ | ||
|
|
||
| import { z } from 'zod'; | ||
|
|
||
| import { | ||
| EqlRuleCreateProps, | ||
| QueryRuleCreateProps, | ||
| SavedQueryRuleCreateProps, | ||
| ThresholdRuleCreateProps, | ||
| ThreatMatchRuleCreateProps, | ||
| MachineLearningRuleCreateProps, | ||
| NewTermsRuleCreateProps, | ||
| EsqlRuleCreateProps, | ||
| } from '../model/rule_schema/rule_schemas.gen'; | ||
| import { NonEmptyString } from '../../model/primitives.gen'; | ||
|
|
||
| export type RulePreviewParams = z.infer<typeof RulePreviewParams>; | ||
| export const RulePreviewParams = z.object({ | ||
| invocationCount: z.number().int(), | ||
| timeframeEnd: z.string().datetime(), | ||
| }); | ||
|
|
||
| export type RulePreviewLogs = z.infer<typeof RulePreviewLogs>; | ||
| export const RulePreviewLogs = z.object({ | ||
| errors: z.array(NonEmptyString), | ||
| warnings: z.array(NonEmptyString), | ||
| /** | ||
| * Execution duration in milliseconds | ||
| */ | ||
| duration: z.number().int(), | ||
| startedAt: NonEmptyString.optional(), | ||
| }); | ||
|
|
||
| export type RulePreviewRequestBody = z.infer<typeof RulePreviewRequestBody>; | ||
| export const RulePreviewRequestBody = z.discriminatedUnion('type', [ | ||
| EqlRuleCreateProps.merge(RulePreviewParams), | ||
| QueryRuleCreateProps.merge(RulePreviewParams), | ||
| SavedQueryRuleCreateProps.merge(RulePreviewParams), | ||
| ThresholdRuleCreateProps.merge(RulePreviewParams), | ||
| ThreatMatchRuleCreateProps.merge(RulePreviewParams), | ||
| MachineLearningRuleCreateProps.merge(RulePreviewParams), | ||
| NewTermsRuleCreateProps.merge(RulePreviewParams), | ||
| EsqlRuleCreateProps.merge(RulePreviewParams), | ||
| ]); | ||
| export type RulePreviewRequestBodyInput = z.input<typeof RulePreviewRequestBody>; | ||
|
|
||
| export type RulePreviewResponse = z.infer<typeof RulePreviewResponse>; | ||
| export const RulePreviewResponse = z.object({ | ||
| logs: z.array(RulePreviewLogs), | ||
| previewId: NonEmptyString.optional(), | ||
| isAborted: z.boolean().optional(), | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| openapi: 3.0.0 | ||
| info: | ||
| title: Rule preview API endpoint | ||
| version: '2023-10-31' | ||
| paths: | ||
| /api/detection_engine/rules/preview: | ||
| post: | ||
| x-labels: [serverless, ess] | ||
| operationId: RulePreview | ||
| x-codegen-enabled: true | ||
| summary: Preview rule alerts generated on specified time range | ||
| tags: | ||
| - Rule preview API | ||
| requestBody: | ||
| description: An object containing tags to add or remove and alert ids the changes will be applied | ||
| required: true | ||
| content: | ||
| application/json: | ||
| schema: | ||
| discriminator: | ||
| propertyName: type | ||
| anyOf: | ||
| - allOf: | ||
| - $ref: '../model/rule_schema/rule_schemas.schema.yaml#/components/schemas/EqlRuleCreateProps' | ||
| - $ref: '#/components/schemas/RulePreviewParams' | ||
| - allOf: | ||
| - $ref: '../model/rule_schema/rule_schemas.schema.yaml#/components/schemas/QueryRuleCreateProps' | ||
| - $ref: '#/components/schemas/RulePreviewParams' | ||
| - allOf: | ||
| - $ref: '../model/rule_schema/rule_schemas.schema.yaml#/components/schemas/SavedQueryRuleCreateProps' | ||
| - $ref: '#/components/schemas/RulePreviewParams' | ||
| - allOf: | ||
| - $ref: '../model/rule_schema/rule_schemas.schema.yaml#/components/schemas/ThresholdRuleCreateProps' | ||
| - $ref: '#/components/schemas/RulePreviewParams' | ||
| - allOf: | ||
| - $ref: '../model/rule_schema/rule_schemas.schema.yaml#/components/schemas/ThreatMatchRuleCreateProps' | ||
| - $ref: '#/components/schemas/RulePreviewParams' | ||
| - allOf: | ||
| - $ref: '../model/rule_schema/rule_schemas.schema.yaml#/components/schemas/MachineLearningRuleCreateProps' | ||
| - $ref: '#/components/schemas/RulePreviewParams' | ||
| - allOf: | ||
| - $ref: '../model/rule_schema/rule_schemas.schema.yaml#/components/schemas/NewTermsRuleCreateProps' | ||
| - $ref: '#/components/schemas/RulePreviewParams' | ||
| - allOf: | ||
| - $ref: '../model/rule_schema/rule_schemas.schema.yaml#/components/schemas/EsqlRuleCreateProps' | ||
| - $ref: '#/components/schemas/RulePreviewParams' | ||
| responses: | ||
| 200: | ||
| description: Successful response | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: object | ||
| properties: | ||
| logs: | ||
| type: array | ||
| items: | ||
| $ref: '#/components/schemas/RulePreviewLogs' | ||
| previewId: | ||
| $ref: '../../model/primitives.schema.yaml#/components/schemas/NonEmptyString' | ||
| isAborted: | ||
| type: boolean | ||
| required: [logs] | ||
| 400: | ||
| description: Invalid input data response | ||
| content: | ||
| application/json: | ||
| schema: | ||
| oneOf: | ||
| - $ref: '../../../model/error_responses.schema.yaml#/components/schemas/PlatformErrorResponse' | ||
| - $ref: '../../../model/error_responses.schema.yaml#/components/schemas/SiemErrorResponse' | ||
| 401: | ||
| description: Unsuccessful authentication response | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../../../model/error_responses.schema.yaml#/components/schemas/PlatformErrorResponse' | ||
| 500: | ||
| description: Internal server error response | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../../../model/error_responses.schema.yaml#/components/schemas/SiemErrorResponse' | ||
|
|
||
| components: | ||
| schemas: | ||
| RulePreviewParams: | ||
| type: object | ||
| properties: | ||
| invocationCount: | ||
| type: integer | ||
| timeframeEnd: | ||
| type: string | ||
| format: date-time | ||
| required: [invocationCount, timeframeEnd] | ||
|
|
||
| RulePreviewLogs: | ||
| type: object | ||
| properties: | ||
| errors: | ||
| type: array | ||
| items: | ||
| $ref: '../../model/primitives.schema.yaml#/components/schemas/NonEmptyString' | ||
| warnings: | ||
| type: array | ||
| items: | ||
| $ref: '../../model/primitives.schema.yaml#/components/schemas/NonEmptyString' | ||
| duration: | ||
| type: integer | ||
| description: Execution duration in milliseconds | ||
| startedAt: | ||
| $ref: '../../model/primitives.schema.yaml#/components/schemas/NonEmptyString' | ||
| required: | ||
| - errors | ||
| - warnings | ||
| - duration |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: I noticed a discrepancy in the naming between operation ids and file names and code. Operation ids are "get something" whereas in the code we have "read something". Why? Is "get something" a naming convention we're going to use for all our API endpoints in OAS?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a good topic to tech time meeting. Since Detections API is most a RESTful API it focuses on data over actions on that data. It looks logical to have the same
Get,Post,Put,Deleteverbs instead of vagueRead,Createand etc.In this PR I place OpenAPI specs in existing folders to minimize the diff. I intend to perform renaming in a separate PR since it's a minor thing and won't impact functionality but the diff could be relatively large.