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

[Doc] Update bulk descriptions #595

Merged
merged 1 commit into from
Oct 1, 2024

Conversation

Naarcha-AWS
Copy link
Contributor

Description

This PR updates description for the Bulk schema, used in the Bulk API.

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 Oct 1, 2024
Copy link

github-actions bot commented Oct 1, 2024

Changes Analysis

Commit SHA: f3ee2f4
Comparing To SHA: 9771b03

API Changes

Summary

└─┬Components
  ├─┬_core.bulk:ResponseItem
  │ └─┬_index
  │   └──[🔀] description (40875:24)
  ├─┬_core.bulk:WriteOperation
  │ └─┬ALLOF
  │   ├─┬require_alias
  │   │ └──[🔀] description (40961:28)
  │   ├─┬pipeline
  │   │ └──[🔀] description (40955:28)
  │   └─┬dynamic_templates
  │     └──[🔀] description (40947:28)
  ├─┬_core.bulk:UpdateAction
  │ ├─┬detect_noop
  │ │ └──[🔀] description (40909:24)
  │ ├─┬doc_as_upsert
  │ │ └──[🔀] description (40917:24)
  │ └─┬scripted_upsert
  │   └──[🔀] description (40922:24)
  └─┬_core.bulk:UpdateOperation
    └─┬ALLOF
      └─┬require_alias
        └──[🔀] description (40937:28)

Document Element Total Changes Breaking Changes
components 8 0
  • Total Changes: 8
  • Modifications: 8

Report

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

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

Copy link

github-actions bot commented Oct 1, 2024

Spec Test Coverage Analysis

Total Tested
504 303 (60.12 %)

type: string
require_alias:
description: If `true`, the request's actions must target an index alias.
description: When `true`, require that all actions target an index alias rather than an index. Default is `false`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the schema supports default: false, when editing text you can add those too.

@dblock dblock merged commit 939a292 into opensearch-project:main Oct 1, 2024
26 of 27 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