Skip to content

Commit

Permalink
remove all catalog schema related assets and change documentation to …
Browse files Browse the repository at this point in the history 
…reflect the new catalog repository https://github.com/opensearch-project/opensearch-catalog/tree/main/docs/schema (#1549)

Signed-off-by: YANGDB <[email protected]>
  • Loading branch information
@YANG-DB
YANG-DB authored Jun 3, 2023
1 parent 8dcb92d commit 4065a6b
Show file tree
Hide file tree
Showing 90 changed files with 45 additions and 7,178 deletions.
27 changes: 12 additions & 15 deletions docs/API/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# API Mock Tests
The [Swagger](swagger.yaml) describes the API used by the Integration repository to support the `catalog`, `registry` and `store` functionalities.
The [Swagger](swagger.yaml) describes the API used by the Integration repository to support the `registry` and `store` functionalities.

Its possible to visualize the REST API using any on the numerous [online editors](https://editor.swagger.io/)
![](API.png)
Expand All @@ -17,9 +17,6 @@ prism mock swagger.yaml
```
The next endpoints are presented:
```
[10:32:12 a.m.] › [CLI] ℹ info GET http://127.0.0.1:4010/catalog?limit=41
[10:32:12 a.m.] › [CLI] ℹ info POST http://127.0.0.1:4010/catalog
[10:32:12 a.m.] › [CLI] ℹ info GET http://127.0.0.1:4010/catalog/sed
[10:32:12 a.m.] › [CLI] ℹ info GET http://127.0.0.1:4010/repository?limit=%5Bobject%20Object%5D
[10:32:12 a.m.] › [CLI] ℹ info POST http://127.0.0.1:4010/repository
[10:32:12 a.m.] › [CLI] ℹ info GET http://127.0.0.1:4010/repository/%5Bobject%20Object%5D
Expand All @@ -34,69 +31,69 @@ The next endpoints are presented:

Once the server has started, a CURL request can be initiated with any of the above endpoints:

`GET http://localhost:4010/catalog`
`GET http://localhost:4010/repository`

Would show in the traffic logs:

`[10:32:23 a.m.] › [HTTP SERVER] get /catalog ℹ info Request received`
`[10:32:23 a.m.] › [HTTP SERVER] get /repository ℹ info Request received`

And will result with :

```json5
{
"catalog": "observability",
"version": "1.0",
"url": "https://github.com/opensearch-project/observability/tree/2.x/schema/observability",
"url": "https://github.com/opensearch-project/opensearch-catalog/tree/main/schema/observability",
"categories": [
{
"category": "logs",
"version": "1.0",
"url": "https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs",
"url": "https://github.com/opensearch-project/opensearch-catalog/tree/main/schema/observability/logs",
"components": [
{
"component": "log",
"version": "1.0",
"url": "https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs/logs",
"url": "https://github.com/opensearch-project/opensearch-catalog/tree/main/schema/observability/logs/logs",
"container": true,
"tags": []
},
{
"component": "http",
"version": "1.0",
"url": "https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs/http",
"url": "https://github.com/opensearch-project/opensearch-catalog/tree/main/schema/observability/logs/http",
"tags": [],
"container": false
},
{
"component": "communication",
"version": "1.0",
"url": "https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs/communication",
"url": "https://github.com/opensearch-project/opensearch-catalog/tree/main/schema/observability/logs/communication",
"tags": ["web"],
"container": false
}]
},
{
"category": "traces",
"version": "1.0",
"url": "https://github.com/opensearch-project/observability/tree/2.x/schema/observability/traces",
"url": "https://github.com/opensearch-project/opensearch-catalog/tree/main/schema/observability/traces",
"components": [
{
"component": "span",
"version": "1.0",
"url": "https://github.com/opensearch-project/observability/tree/2.x/schema/observability/traces/traces",
"url": "https://github.com/opensearch-project/opensearch-catalog/tree/main/schema/observability/traces/traces",
"tags": [],
"container": true
}]
},
{
"category": "metrics",
"version": "1.0",
"url": "https://github.com/opensearch-project/observability/tree/2.x/schema/observability/metrics",
"url": "https://github.com/opensearch-project/opensearch-catalog/tree/main/schema/observability/metrics",
"components": [
{
"component": "metric",
"version": "1.0",
"url": "https://github.com/opensearch-project/observability/tree/2.x/schema/observability/metrics/metrics",
"url": "https://github.com/opensearch-project/opensearch-catalog/tree/main/schema/observability/metrics/metrics",
"tags": [],
"container": true
}]
Expand Down
231 changes: 0 additions & 231 deletions docs/API/swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,237 +12,6 @@ tags:
- name: developers
description: Operations available to regular developers
paths:
/catalog:
get:
tags:
- developers
summary: schema list of loaded catalogs
operationId: searchCatalog
description: |
By passing in the appropriate search attributes, you can search for
available catalogs in the system
parameters:
- in: query
name: searchString
description: pass an optional search string for looking up catalog components
required: false
schema:
type: string
- in: query
name: limit
description: maximum number of records to return
schema:
type: integer
format: int32
minimum: 0
maximum: 50
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
type: array
items:
$ref: '../../src/main/resources/schema/system/catalog.schema'
example:
observability:
application/json:
schema:
type: array
items:
$ref: '../../src/main/resources/schema/system/catalog.schema'
examples:
catalog: observability
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability
categories:
- category: logs
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs
components:
- component: log
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs/logs
container: true
tags: [ ]
- component: http
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs/http
tags: [ ]
container: false
- component: communication
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs/communication
tags:
- web
container: false
- category: traces
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/traces
components:
- component: span
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/traces/traces
tags: [ ]
container: true
- category: metrics
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/metrics
components:
- component: metric
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/metrics/metrics
tags: [ ]
container: true
'400':
description: bad input parameter
post:
tags:
- admins
summary: adds a catalog item
operationId: addCatalog
description: |
Adds a catalog item to the system, expecting the internal URLs to be accessible
requestBody:
description: Inventory item to add
required: true
content:
application/json:
schema:
$ref: '../../src/main/resources/schema/system/catalog.schema'
example:
observability:
application/json:
schema:
type: array
items:
$ref: '../../src/main/resources/schema/system/catalog.schema'
examples:
catalog: observability
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability
categories:
- category: logs
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs
components:
- component: log
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs/logs
container: true
tags: [ ]
- component: http
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs/http
tags: [ ]
container: false
- component: communication
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs/communication
tags:
- web
container: false
- category: traces
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/traces
components:
- component: span
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/traces/traces
tags: [ ]
container: true
- category: metrics
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/metrics
components:
- component: metric
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/metrics/metrics
tags: [ ]
container: true

responses:
'201':
description: item created
'400':
description: 'invalid input, object invalid'
'409':
description: an existing item already exists
/catalog/{id}:
get:
tags:
- developers
summary: get catalog by id
operationId: catalogById
description: |
Get a specific catalog by Id
parameters:
- in: path
name: id
description: catalog instance Id
required: true
schema:
type: string
responses:
'200':
description: catalog
content:
application/json:
schema:
$ref: '../../src/main/resources/schema/system/catalog.schema'
example:
observability:
application/json:
schema:
type: array
items:
$ref: '../../src/main/resources/schema/system/catalog.schema'
examples:
catalog: observability
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability
categories:
- category: logs
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs
components:
- component: log
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs/logs
container: true
tags: [ ]
- component: http
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs/http
tags: [ ]
container: false
- component: communication
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/logs/communication
tags:
- web
container: false
- category: traces
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/traces
components:
- component: span
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/traces/traces
tags: [ ]
container: true
- category: metrics
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/metrics
components:
- component: metric
version: '1.0'
url: https://github.com/opensearch-project/observability/tree/2.x/schema/observability/metrics/metrics
tags: [ ]
container: true
'400':
description: bad input parameter
/repository:
get:
tags:
Expand Down
5 changes: 0 additions & 5 deletions docs/Integration-API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ GET _integration/repository?filter=category:logs&component:web
"resource": "^1.23.0"
},
"description": "Nginx HTTP server collector",
"Information":"file:///.../schema/logs/info.html",
"identification": "instrumentationScope.attributes.identification",
"catalog": "observability",
"collection":[
Expand Down Expand Up @@ -70,9 +69,6 @@ GET _integration/repository?filter=category:logs&component:web
}
}
```
The integration object schema is supported by both B/E & F/E for display & query to the correct fields
[Integration config schema](https://github.com/opensearch-project/observability/blob/9a22f061f568443651fe38d96c864901eed12340/schema/system/integration.schema)

---
The backend responsibilities :
- scan the Integration folder (on-load)
Expand Down Expand Up @@ -148,7 +144,6 @@ each representing different domain / aspect such as geographic.
"resource": "^1.23.0"
},
"description": "Nginx HTTP server collector",
"Information":"file:///.../schema/logs/info.html",
"identification": "instrumentationScope.attributes.identification",
"catalog": "observability",
"collection":[
Expand Down
3 changes: 3 additions & 0 deletions docs/Integration-fields-mapping.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ This information is assumed to be in the specific structure dictated by the cata

These fields must exist and match type in the physical index representing the data-stream.

The [catalog repository](https://github.com/opensearch-project/opensearch-catalog/tree/main/docs/schema) is responsible for providing all the relevant information and API for
accessing, searching, fetching and applying the schema.

## Problem
Some users may already have existing indices that function as data source for these specific displays. The index mapping used by these indices may have different names that represent a similar meaning.

Expand Down
2 changes: 1 addition & 1 deletion docs/Integration-loading.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ indicating some components weren’t loaded / created as required and the approp


*- Index may not exist*
*- Dashboard could failed importing (name collision)*
*- Dashboard could fail importing (name collision)*
*- Configuration is broken for some component and needs mending*
Once the issues are corrected it will transform to the ***Ready2Ingest** *stage

Expand Down
Loading

0 comments on commit 4065a6b

Please sign in to comment.