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

Document and validate object_type #417

Merged
merged 1 commit into from
Sep 14, 2022
Merged

Conversation

jsoriano
Copy link
Member

@jsoriano jsoriano commented Sep 14, 2022

Document and validate the accepted values for object_type and object_type_mapping_type.

Adding the list of accepted values could be a breaking change, but this is not heavily used, and when used, it is only with a reduced subset of the values accepted in this PR. I could apply this only for 2.0.0 if this is a concern.

Implemented in Kibana in elastic/kibana#137772.

Reference to the use in the array type removed because of #412.

Fixes #415
Fixes #416

@jsoriano jsoriano added the Team:Ecosystem Label for the Packages Ecosystem team label Sep 14, 2022
@jsoriano jsoriano requested a review from endorama September 14, 2022 08:56
@jsoriano jsoriano self-assigned this Sep 14, 2022
@jsoriano jsoriano requested a review from a team as a code owner September 14, 2022 08:56
@elasticmachine
Copy link

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-09-14T08:57:01.938+0000

  • Duration: 7 min 56 sec

Test stats 🧪

Test Results
Failed 0
Passed 622
Skipped 0
Total 622

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@elasticmachine
Copy link

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (7/7) 💚
Files 70.833% (17/24) 👍
Classes 78.788% (26/33) 👍
Methods 58.824% (60/102) 👍
Lines 44.592% (536/1202) 👍
Conditionals 100.0% (0/0) 💚

Copy link
Contributor

@mrodm mrodm left a comment

Choose a reason for hiding this comment

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

LGTM

As you mentioned, as the current packages are already using a subset of the values defined here, I think we can release it before 2.0.0

@jsoriano jsoriano merged commit a012e18 into elastic:main Sep 14, 2022
@jsoriano jsoriano deleted the object-type-docs branch September 14, 2022 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Ecosystem Label for the Packages Ecosystem team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

object_type_mapping_type is not defined nor documented object_type documentation and values
3 participants