Skip to content
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

Fix quotes in descriptions. #402

Merged
merged 2 commits into from
Jul 11, 2024
Merged

Conversation

dblock
Copy link
Member

@dblock dblock commented Jul 10, 2024

Description

While we don't have a lot of descriptions try to be a little more disciplined about quotes in them.

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.

@dblock dblock added the skip-changelog No need to update CHANGELOG. label Jul 10, 2024
@dblock dblock force-pushed the fix-descriptions branch from c52abff to 09f3016 Compare July 10, 2024 22:18
dblock added 2 commits July 10, 2024 18:19
@dblock dblock force-pushed the fix-descriptions branch from 09f3016 to da76ff4 Compare July 10, 2024 22:19
Copy link
Contributor

github-actions bot commented Jul 10, 2024

Changes Analysis

Commit SHA: da76ff4
Comparing To SHA: 45953f0

API Changes

Summary

├─┬Paths
│ ├─┬/{index}/_bulk
│ │ ├─┬PUT
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (11560:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (11560:20)
│ ├─┬/{index}/_aliases/{name}
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (16944:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └─┬is_write_index
│ │ │         └──[🔀] description (21911:30)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (16944:20)
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬is_write_index
│ │           └──[🔀] description (21911:30)
│ ├─┬/{index}/_analyze
│ │ ├─┬GET
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └─┬analyzer
│ │ │         └──[🔀] description (21829:30)
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬analyzer
│ │           └──[🔀] description (21829:30)
│ ├─┬/_reindex
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (19424:20)
│ ├─┬/_bulk
│ │ ├─┬PUT
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (11560:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (11560:20)
│ ├─┬/_ingest/pipeline/{id}/_simulate
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (18077:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (18077:20)
│ ├─┬/_cluster/stats/nodes/{node_id}
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[🔀] description (14064:20)
│ ├─┬/_plugins/_transform
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (21181:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (21189:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (21165:20)
│ ├─┬/_search/scroll
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (19556:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (19556:20)
│ ├─┬/_component_template/{name}
│ │ ├─┬PUT
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (13808:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (13808:20)
│ ├─┬/{index}/_alias/{name}
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (16944:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └─┬is_write_index
│ │ │         └──[🔀] description (21911:30)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (16944:20)
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬is_write_index
│ │           └──[🔀] description (21911:30)
│ ├─┬/_search/scroll/{scroll_id}
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (19556:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (19556:20)
│ ├─┬/_cluster/stats
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[🔀] description (14064:20)
│ ├─┬/{index}/_create/{id}
│ │ ├─┬PUT
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (14259:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (14259:20)
│ └─┬/_analyze
│   ├─┬GET
│   │ └─┬Requestbody
│   │   └─┬application/json
│   │     └─┬Schema
│   │       └─┬analyzer
│   │         └──[🔀] description (21829:30)
│   └─┬POST
│     └─┬Requestbody
│       └─┬application/json
│         └─┬Schema
│           └─┬analyzer
│             └──[🔀] description (21829:30)
└─┬Components
  ├─┬cluster.stats:RuntimeFieldTypes
  │ └─┬scriptless_count
  │   └──[🔀] description (41218:24)
  ├─┬_core.rank_eval:RankEvalMetricDetail
  │ └─┬unrated_docs
  │   └──[🔀] description (37007:24)
  ├─┬_common.query_dsl:SpanNotQuery
  │ ├─┬ALLOF
  │ │ └──[🔀] $ref (35496:13)❌ 
  │ └─┬ALLOF
  │   └──[🔀] $ref (36097:11)❌ 
  ├─┬_common.query_dsl:RegexpQuery
  │ └─┬ALLOF
  │   └─┬case_insensitive
  │     └──[🔀] description (35883:28)
  ├─┬_core.scripts_painless_execute:PainlessContextSetup
  │ └─┬document
  │   └──[🔀] description (37269:24)
  ├─┬_common.query_dsl:TermQuery
  │ └─┬ALLOF
  │   └─┬case_insensitive
  │     └──[🔀] description (36188:28)
  ├─┬_core.rank_eval:DocumentRating
  │ └─┬rating
  │   └──[🔀] description (36950:24)
  ├─┬_common.query_dsl:FieldValueFactorScoreFunction
  │ └─┬missing
  │   └──[🔀] description (34660:24)
  ├─┬cat.allocation:AllocationRecord
  │ ├─┬disk.avail
  │ │ └──[🔀] description (38402:24)
  │ ├─┬disk.indices
  │ │ └──[🔀] description (38384:24)
  │ └─┬disk.used
  │   └──[🔀] description (38392:24)
  ├─┬_core.bulk:UpdateOperation
  │ └─┬ALLOF
  │   └─┬require_alias
  │     └──[🔀] description (36461:28)
  ├─┬cat.shards:ShardsRecord
  │ └─┬unassigned.reason
  │   └──[🔀] description (39528:24)
  ├─┬indices._common:DataStream
  │ ├─┬indices
  │ │ └──[🔀] description (41359:24)
  │ └─┬generation
  │   └──[🔀] description (41346:24)
  ├─┬indices._common:MappingLimitSettingsFieldNameLength
  │ └─┬limit
  │   └──[🔀] description (41959:24)
  ├─┬indices.data_streams_stats:DataStreamsStatsItem
  │ └─┬store_size_bytes
  │   └──[🔀] description (42459:24)
  ├─┬_core.search:HighlightBase
  │ └─┬max_analyzed_offset
  │   └──[🔀] description (37609:24)
  ├─┬_common.aggregations:PipelineAggregationBase
  │ └─┬ALLOF
  │   └─┬format
  │     └──[🔀] description (30383:28)
  ├─┬ingest._common:GrokProcessor
  │ └─┬ALLOF
  │   └─┬trace_match
  │     └──[🔀] description (43703:28)
  ├─┬_core.bulk:WriteOperation
  │ └─┬ALLOF
  │   ├─┬require_alias
  │   │ └──[🔀] description (36486:28)
  │   └─┬dynamic_templates
  │     └──[🔀] description (36471:28)
  ├─┬_common.query_dsl:WildcardQuery
  │ ├─┬ALLOF
  │ │ └──[🔀] $ref (36277:11)❌ 
  │ └─┬ALLOF
  │   └──[🔀] $ref (35496:13)❌ 
  ├─┬ingest._common:CircleProcessor
  │ └─┬ALLOF
  │   └─┬error_distance
  │     └──[🔀] description (43415:28)
  ├─┬_common.aggregations:BucketCorrelationFunctionCountCorrelationIndicator
  │ └─┬doc_count
  │   └──[🔀] description (28221:24)
  ├─┬nodes._common:Client
  │ ├─┬last_uri
  │ │ └──[🔀] description (44458:24)
  │ └─┬x_opaque_id
  │   └──[🔀] description (44476:24)
  ├─┬indices._common:IndexSettingsLifecycle
  │ └─┬parse_origination_date
  │   └──[🔀] description (41802:24)
  ├─┬_common.query_dsl:PrefixQuery
  │ └─┬ALLOF
  │   └─┬case_insensitive
  │     └──[🔀] description (35489:28)
  └─┬_core.field_caps:FieldCapability
    └─┬metric_conflicts_indices
      └──[🔀] description (36552:24)

Document Element Total Changes Breaking Changes
paths 32 0
components 32 8
  • BREAKING Changes: 8 out of 64
  • Modifications: 64
  • Breaking Modifications: 4

Report

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

API Coverage

Before After Δ
Covered (%) 483 (47.31 %) 483 (47.31 %) 0 (0 %)
Uncovered (%) 538 (52.69 %) 538 (52.69 %) 0 (0 %)
Unknown 24 24 0

@Xtansia Xtansia merged commit 32673b2 into opensearch-project:main Jul 11, 2024
8 checks passed
@dblock dblock deleted the fix-descriptions branch July 11, 2024 03:50
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