Skip to content

[Docs] Add and edit observability descriptions #864

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.

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

Conversation

Naarcha-AWS
Copy link
Contributor

Adds descriptions for all Observability APIs.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link
Contributor

github-actions bot commented Apr 9, 2025

Changes Analysis

Commit SHA: 70c8673
Comparing To SHA: aaf974d

API Changes

Summary

├─┬Paths
│ ├─┬/_plugins/_observability/object/{object_id}
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (25006:20)
│ │ │ └─┬Responses
│ │ │   ├─┬200
│ │ │   │ └──[🔀] description (32906:20)
│ │ │   └─┬404
│ │ │     └──[🔀] description (32912:20)
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (25014:20)
│ │ │ └─┬Responses
│ │ │   ├─┬200
│ │ │   │ ├──[🔀] description (32924:20)
│ │ │   │ └─┬application/json
│ │ │   │   └─┬Schema
│ │ │   │     └─┬objectId
│ │ │   │       └──[➕] description (32932:30)
│ │ │   └─┬404
│ │ │     └──[🔀] description (32934:20)
│ │ └─┬DELETE
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (24982:20)
│ │   └─┬Responses
│ │     ├─┬404
│ │     │ └──[🔀] description (32876:20)
│ │     └─┬200
│ │       ├──[🔀] description (32864:20)
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └─┬deleteResponseList
│ │             └──[➕] description (32871:30)
│ ├─┬/_plugins/_observability/_local/stats
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └──[🔀] description (32900:20)
│ └─┬/_plugins/_observability/object
│   ├─┬GET
│   │ └─┬Responses
│   │   └─┬200
│   │     └──[🔀] description (32918:20)
│   ├─┬POST
│   │ └─┬Responses
│   │   └─┬200
│   │     └──[🔀] description (32855:20)
│   └─┬DELETE
│     ├─┬Parameters
│     │ └──[🔀] description (24990:20)
│     ├─┬Parameters
│     │ └──[🔀] description (24998:20)
│     └─┬Responses
│       ├─┬404
│       │ └──[🔀] description (32894:20)
│       └─┬200
│         ├──[🔀] description (32882:20)
│         └─┬application/json
│           └─┬Schema
│             └─┬deleteResponseList
│               └──[➕] description (32889:30)
└─┬Components
  ├─┬observability._common___SelectedTimestamp
  │ ├──[➕] description (61195:20)
  │ ├─┬name
  │ │ └──[➕] description (61199:24)
  │ └─┬type
  │   └──[➕] description (61202:24)
  ├─┬observability._common___OperationalPanel
  │ ├──[➕] description (61057:20)
  │ ├─┬visualizations
  │ │ └──[➕] description (61064:24)
  │ ├─┬applicationId
  │ │ └──[➕] description (61073:24)
  │ └─┬name
  │   └──[➕] description (61061:24)
  ├─┬observability._common___NotFoundResponse
  │ └──[➕] description (60999:20)
  ├─┬observability._common___SavedVisualization
  │ ├──[➕] description (61133:20)
  │ ├─┬query
  │ │ └──[➕] description (61143:24)
  │ ├─┬description
  │ │ └──[➕] description (61140:24)
  │ ├─┬type
  │ │ └──[➕] description (61146:24)
  │ └─┬name
  │   └──[➕] description (61137:24)
  ├─┬observability._common___TimeRange
  │ ├──[➕] description (61208:20)
  │ ├─┬to
  │ │ └──[➕] description (61212:24)
  │ └─┬from
  │   └──[➕] description (61215:24)
  ├─┬observability._common___ObservabilityObjectList
  │ ├──[➕] description (61034:20)
  │ ├─┬startIndex
  │ │ └──[➕] description (61038:24)
  │ ├─┬observabilityObjectList
  │ │ └──[➕] description (61047:24)
  │ ├─┬totalHitRelation
  │ │ └──[➕] description (61044:24)
  │ └─┬totalHits
  │   └──[➕] description (61041:24)
  ├─┬observability._common___SelectedDateRange
  │ ├──[➕] description (61163:20)
  │ ├─┬text
  │ │ └──[➕] description (61173:24)
  │ ├─┬end
  │ │ └──[➕] description (61170:24)
  │ └─┬start
  │   └──[➕] description (61167:24)
  ├─┬observability._common___RootCause
  │ ├─┬type
  │ │ └──[➕] description (61098:24)
  │ └─┬reason
  │   └──[➕] description (61101:24)
  ├─┬observability._common___SelectedFields
  │ ├──[➕] description (61180:20)
  │ ├─┬tokens
  │ │ └──[➕] description (61187:24)
  │ └─┬text
  │   └──[➕] description (61184:24)
  ├─┬observability._common___SavedQuery
  │ ├──[➕] description (61107:20)
  │ ├─┬query
  │ │ └──[➕] description (61117:24)
  │ ├─┬description
  │ │ └──[➕] description (61114:24)
  │ └─┬name
  │   └──[➕] description (61111:24)
  ├─┬observability._common___Visualization
  │ ├──[➕] description (61234:20)
  │ ├─┬h
  │ │ └──[➕] description (61253:24)
  │ ├─┬savedVisualizationId
  │ │ └──[➕] description (61241:24)
  │ ├─┬y
  │ │ └──[➕] description (61247:24)
  │ ├─┬id
  │ │ └──[➕] description (61238:24)
  │ ├─┬w
  │ │ └──[➕] description (61250:24)
  │ └─┬x
  │   └──[➕] description (61244:24)
  ├─┬observability._common___Token
  │ ├──[➕] description (61221:20)
  │ ├─┬name
  │ │ └──[➕] description (61225:24)
  │ └─┬type
  │   └──[➕] description (61228:24)
  ├─┬observability._common___ObservabilityObject
  │ ├──[➕] description (61010:20)
  │ ├─┬objectId
  │ │ └──[➕] description (61014:24)
  │ ├─┬lastUpdatedTimeMs
  │ │ └──[➕] description (61017:24)
  │ ├─┬createdTimeMs
  │ │ └──[➕] description (61020:24)
  │ └─┬tenant
  │   └──[➕] description (61023:24)
  ├─┬observability._common___QueryFilter
  │ ├──[➕] description (61082:20)
  │ ├─┬query
  │ │ └──[➕] description (61086:24)
  │ └─┬language
  │   └──[➕] description (61089:24)
  └─┬observability._common___ErrorResponse
    ├──[➕] description (60980:20)
    ├─┬reason
    │ └──[➕] description (60992:24)
    ├─┬type
    │ └──[➕] description (60989:24)
    └─┬root_cause
      └──[➕] description (60984:24)

Document Element Total Changes Breaking Changes
paths 19 0
components 56 0
  • Total Changes: 75
  • Modifications: 16
  • Additions: 59

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/14364033636/artifacts/2913695634

API Coverage

Before After Δ
Covered (%) 663 (64.94 %) 663 (64.94 %) 0 (0 %)
Uncovered (%) 358 (35.06 %) 358 (35.06 %) 0 (0 %)
Unknown 49 49 0

@Naarcha-AWS
Copy link
Contributor Author

I can't tell if the test failure is related to the content of this PR. Can anyone assist?

Copy link
Contributor

Spec Test Coverage Analysis

Total Tested
599 597 (99.67 %)

@nhtruong nhtruong added the skip-changelog No need to update CHANGELOG. label Apr 14, 2025
@nhtruong nhtruong merged commit 5e7e1e0 into opensearch-project:main Apr 14, 2025
32 of 41 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No need to update CHANGELOG.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants