Skip to content

Commit

Permalink
adjust specs
Browse files Browse the repository at this point in the history
  • Loading branch information
@miloszmarcinkowski
miloszmarcinkowski committed Oct 31, 2024
1 parent f8e3ac5 commit aa8a052
Show file tree
Hide file tree
Showing 15 changed files with 182 additions and 59 deletions.
109 changes: 79 additions & 30 deletions x-pack/plugins/observability_solution/apm/docs/openapi/apm/bundled.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -525,15 +525,17 @@
"description": "Service name",
"schema": {
"type": "string"
}
},
"example": "node"
},
{
"name": "environment",
"in": "query",
"description": "Service environment",
"schema": {
"type": "string"
}
},
"example": "prod"
}
],
"responses": {
Expand Down Expand Up @@ -733,7 +735,8 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "node"
}
],
"responses": {
Expand Down Expand Up @@ -1182,6 +1185,12 @@
"properties": {
"agentKey": {
"type": "object",
"required": [
"id",
"name",
"api_key",
"encoded"
],
"properties": {
"expiration": {
"type": "integer",
Expand All @@ -1193,6 +1202,9 @@
"name": {
"type": "string"
},
"api_key": {
"type": "string"
},
"encoded": {
"type": "string"
}
Expand Down Expand Up @@ -1295,12 +1307,19 @@
},
"create_annotation_object": {
"type": "object",
"required": [
"@timestamp",
"service"
],
"properties": {
"@timestamp": {
"type": "string"
},
"service": {
"type": "object",
"required": [
"version"
],
"properties": {
"version": {
"type": "string"
Expand Down Expand Up @@ -1334,7 +1353,15 @@
"type": "object",
"properties": {
"annotation": {
"type": "string"
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
}
}
},
"tags": {
"type": "array",
Expand Down Expand Up @@ -1395,10 +1422,12 @@
"type": "object",
"properties": {
"name": {
"type": "string"
"type": "string",
"example": "node"
},
"environment": {
"type": "string"
"type": "string",
"example": "prod"
}
}
},
Expand Down Expand Up @@ -1427,13 +1456,16 @@
"$ref": "#/components/schemas/settings_object"
},
"@timestamp": {
"type": "number"
"type": "number",
"example": 1730194190636
},
"applied_by_agent": {
"type": "boolean"
"type": "boolean",
"example": true
},
"etag": {
"type": "string"
"type": "string",
"example": "0bc3b5ebf18fba8163fe4c96f491e3767a358f85"
}
}
},
Expand Down Expand Up @@ -1503,7 +1535,8 @@
},
"etag": {
"type": "string",
"description": "If etags match then `applied_by_agent` field will be set to `true`"
"description": "If etags match then `applied_by_agent` field will be set to `true`",
"example": "0bc3b5ebf18fba8163fe4c96f491e3767a358f85"
},
"mark_as_applied_by_agent": {
"type": "boolean",
Expand Down Expand Up @@ -1532,7 +1565,8 @@
"type": "object",
"properties": {
"name": {
"type": "string"
"type": "string",
"example": "ALL_OPTION_VALUE"
},
"alreadyConfigured": {
"type": "boolean"
Expand All @@ -1554,7 +1588,8 @@
"type": "object",
"properties": {
"agentName": {
"type": "string"
"type": "string",
"example": "nodejs"
}
}
},
Expand Down Expand Up @@ -1612,29 +1647,43 @@
"body": {
"type": "object",
"properties": {
"version": {
"type": "number"
},
"file": {
"serviceName": {
"type": "string"
},
"sources": {
"type": "array",
"items": {
"type": "string"
}
},
"sourcesContent": {
"type": "array",
"items": {
"type": "string"
}
},
"mappings": {
"serviceVersion": {
"type": "string"
},
"sourceRoot": {
"bundleFilepath": {
"type": "string"
},
"sourceMap": {
"type": "object",
"properties": {
"version": {
"type": "number"
},
"file": {
"type": "string"
},
"sources": {
"type": "array",
"items": {
"type": "string"
}
},
"sourcesContent": {
"type": "array",
"items": {
"type": "string"
}
},
"mappings": {
"type": "string"
},
"sourceRoot": {
"type": "string"
}
}
}
}
}
Expand Down
65 changes: 51 additions & 14 deletions x-pack/plugins/observability_solution/apm/docs/openapi/apm/bundled.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -317,11 +317,13 @@ paths:
description: Service name
schema:
type: string
example: node
- name: environment
in: query
description: Service environment
schema:
type: string
example: prod
responses:
'200':
description: Successful response
Expand Down Expand Up @@ -442,6 +444,7 @@ paths:
required: true
schema:
type: string
example: node
responses:
'200':
description: Successful response
Expand Down Expand Up @@ -714,6 +717,11 @@ components:
properties:
agentKey:
type: object
required:
- id
- name
- api_key
- encoded
properties:
expiration:
type: integer
Expand All @@ -722,6 +730,8 @@ components:
type: string
name:
type: string
api_key:
type: string
encoded:
type: string
400_response:
Expand Down Expand Up @@ -789,11 +799,16 @@ components:
type: string
create_annotation_object:
type: object
required:
- '@timestamp'
- service
properties:
'@timestamp':
type: string
service:
type: object
required:
- version
properties:
version:
type: string
Expand All @@ -816,7 +831,12 @@ components:
type: object
properties:
annotation:
type: string
type: object
properties:
type:
type: string
title:
type: string
tags:
type: array
items:
Expand Down Expand Up @@ -856,8 +876,10 @@ components:
properties:
name:
type: string
example: node
environment:
type: string
example: prod
settings_object:
type: object
additionalProperties:
Expand All @@ -878,10 +900,13 @@ components:
$ref: '#/components/schemas/settings_object'
'@timestamp':
type: number
example: 1730194190636
applied_by_agent:
type: boolean
example: true
etag:
type: string
example: 0bc3b5ebf18fba8163fe4c96f491e3767a358f85
agent_configurations_response:
type: object
properties:
Expand Down Expand Up @@ -925,6 +950,7 @@ components:
etag:
type: string
description: If etags match then `applied_by_agent` field will be set to `true`
example: 0bc3b5ebf18fba8163fe4c96f491e3767a358f85
mark_as_applied_by_agent:
type: boolean
description: |
Expand All @@ -946,6 +972,7 @@ components:
properties:
name:
type: string
example: ALL_OPTION_VALUE
alreadyConfigured:
type: boolean
service_environments_response:
Expand All @@ -960,6 +987,7 @@ components:
properties:
agentName:
type: string
example: nodejs
base_source_map_object:
type: object
properties:
Expand Down Expand Up @@ -999,22 +1027,31 @@ components:
body:
type: object
properties:
version:
type: number
file:
serviceName:
type: string
sources:
type: array
items:
type: string
sourcesContent:
type: array
items:
type: string
mappings:
serviceVersion:
type: string
sourceRoot:
bundleFilepath:
type: string
sourceMap:
type: object
properties:
version:
type: number
file:
type: string
sources:
type: array
items:
type: string
sourcesContent:
type: array
items:
type: string
mappings:
type: string
sourceRoot:
type: string
- $ref: '#/components/schemas/base_source_map_object'
501_response:
type: object
Expand Down
3 changes: 3 additions & 0 deletions ...vability_solution/apm/docs/openapi/apm/components/schemas/agent_configuration_object.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ properties:
$ref: 'settings_object.yaml'
'@timestamp':
type: number
example: 1730194190636
applied_by_agent:
type: boolean
example: true
etag:
type: string
example: 0bc3b5ebf18fba8163fe4c96f491e3767a358f85
Loading

0 comments on commit aa8a052

Please sign in to comment.