Skip to content

update integrations documentation #1492

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
YANG-DB merged 4 commits into from
Apr 5, 2023
Merged

update integrations documentation #1492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
38fbf81
update documentation folder to reflect the integration purpose and st…
YANG-DB Apr 5, 2023
eff3e4b
revert unneeded delete
YANG-DB Apr 5, 2023
7e1abc5
Merge remote-tracking branch 'origin/update_docs' into update_docs
YANG-DB Apr 5, 2023
836b3df
revert unneeded delete
YANG-DB Apr 5, 2023
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
113 changes: 113 additions & 0 deletions docs/API/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
# API Mock Tests
The [Swagger](swagger.yaml) describes the API used by the Integration repository to support the `catalog`, `registry` and `store` functionalities.

### Setup mock server
In order to test the API, we can utilize a swagger based mock library which allows ['contract based testing'](https://github.com/stoplightio/prism).

#### running the swagger mock server
````
npm install -g @stoplight/prism-cli
````
Once this tool is installed, the server can be run using the next command
```
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
[10:32:12 a.m.] › [CLI] ℹ info GET http://127.0.0.1:4010/store?limit=25
[10:32:12 a.m.] › [CLI] ℹ info POST http://127.0.0.1:4010/store
[10:32:12 a.m.] › [CLI] ℹ info GET http://127.0.0.1:4010/store/cum
[10:32:12 a.m.] › [CLI] ℹ info POST http://127.0.0.1:4010/store/nihil/validate
[10:32:12 a.m.] › [CLI] ℹ info POST http://127.0.0.1:4010/store/laudantium/upload
[10:32:12 a.m.] › [CLI] ℹ info PUT http://127.0.0.1:4010/store/nihil/activate
[10:32:12 a.m.] › [CLI] ▶ start Prism is listening on http://127.0.0.1:4010
```

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

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

Would show in the traffic logs:

`[10:32:23 a.m.] › [HTTP SERVER] get /catalog ℹ 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",
"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
}]
}
]
}
```



#### running the swagger mock server as docker

One-liner docker command (assuming running from repository root):

```text
docker run -p 9200:4010 -v "$(pwd)/docs/API:/api" -v "$(pwd)/schema:/schema" --name integ-prism -t stoplight/prism mock -h 0.0.0.0 /api/swagger.yaml
```
Loading