opensearch-project / opensearch-api-specification

API specification for OpenSearch
Apache License 2.0
35 stars 62 forks source link

Add spec for opensearch phone plugin. #610

Closed dblock closed 3 weeks ago

dblock commented 1 month ago

Description

Describe what this change achieves.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

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.

github-actions[bot] commented 1 month ago

Changes Analysis

Commit SHA: ff187df1291ad81abcec27a4af4135eb4e431083 Comparing To SHA: 49b7c6895871209a489cccd7d3eb4fabba8e241c

API Changes

Summary

├─┬Paths
│ └─┬/_snapshot/{repository}/{snapshot}
│   └─┬GET
│     └─┬Responses
│       └─┬200
│         └─┬application/json
│           └─┬Schema
│             ├──[➕] required (29743:17)❌ 
│             ├──[➖] required (29753:17)❌ 
│             ├──[➖] required (29754:17)❌ 
│             ├──[➖] properties (29749:15)❌ 
│             ├──[➖] properties (29738:15)❌ 
│             └──[➖] properties (29746:15)❌ 
└─┬Components
  ├──[➖] schemas (55111:7)❌ 
  ├──[➖] schemas (55096:7)❌ 
  ├──[➖] schemas (55376:7)❌ 
  ├──[➕] schemas (36963:7)
  ├─┬_common.analysis:Analyzer
  │ ├──[➕] oneOf (36187:7)
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (36963:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (35955:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (36859:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (37213:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (37129:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (36028:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (36390:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (37269:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (36106:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (36593:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (37118:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (35883:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (37158:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (36447:13)❌ 
  │ └─┬ONEOF
  │   └──[🔀] $ref (36766:13)❌ 
  └─┬snapshot._common:SnapshotInfo
    ├──[➖] properties (55277:9)❌ 
    ├──[➖] properties (55251:9)❌ 
    └──[➖] properties (55259:9)❌ 
Document Element Total Changes Breaking Changes
paths 6 6
components 23 21

Report

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

API Coverage

Before After Δ
Covered (%) 588 (57.59 %) 588 (57.59 %) 0 (0 %)
Uncovered (%) 433 (42.41 %) 433 (42.41 %) 0 (0 %)
Unknown 29 29 0
dblock commented 1 month ago

The approach in this PR is not ideal, waiting on https://github.com/opensearch-project/OpenSearch/pull/16219 and/or https://github.com/opensearch-project/opensearch-build/issues/5096.

dblock commented 3 weeks ago

I thought I was reviewing Ralph's PR, instead commented on my own 🤦