docs: update api reference documentation #891
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
||
| Args: | ||
| splunk_search_util (SearchUtil): Object that helps to search on Splunk. | ||
| splunk_ingest_data (fixture): Unused but required to ensure data was ingested before running test |
There was a problem hiding this comment.
Can we remove this unused line as we are using it.
| splunk_ingest_data (fixture): Unused but required to ensure data was ingested before running test | ||
| splunk_setup (fixture): Unused but required to ensure that test environment was set up before running test | ||
| splunk_searchtime_cim_fields (fixture): Pytest parameter to test required cim field extraction | ||
| record_property (fixture): Document facts of test cases. |
There was a problem hiding this comment.
we can add that we document it provide more info in the test failure reports
| Args: | ||
| splunk_ingest_data (fixture): Unused but required to ensure data was ingested before running test | ||
| splunk_search_util (SearchUtil): Object that helps to search on Splunk. | ||
| splunk_setup (fixture): Unused but required to ensure that test environment was set up before running test |
| @@ -491,6 +513,13 @@ def test_eventtype_mapped_multiple_cim_datamodel( | |||
| def test_cim_fields_recommended( | |||
| self, splunk_dm_recommended_fields, splunk_searchtime_cim_fields_recommended | |||
| ): | |||
| """ | |||
| This test case check that all the recommended cim fields of datamodel mapped with event are exracted. | |||
| @@ -37,6 +46,15 @@ def parse_sample_files(folder_path): | |||
|
|
|||
|
|
|||
| def parse_file(filename): | |||
| """ | |||
| Parse the xml sample file to get the lisst of events | |||
| @@ -269,11 +363,23 @@ def __init__(self, event_tag): | |||
| self.exceptions = self.extract_key_value_xml("exceptions") | |||
|
|
|||
| def get_transport_type(self): | |||
| """ | |||
| Function to get the transport type of the evnt | |||
There was a problem hiding this comment.
Please check for small typos for this PR.
Overall looks good, small comments added
There was a problem hiding this comment.
Updated as per the comments and fixed typos.
harshilgajera-crest
approved these changes
Oct 7, 2024
|
🎉 This PR is included in version 5.4.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates API reference documentation as below
Ref: https://splunk.atlassian.net/browse/ADDON-75003