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

CBAPI-5261: Guide page for Audit Log functionality #505

Merged
merged 4 commits into from
Apr 26, 2024

Conversation

abowersox-cb
Copy link
Contributor

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Tests have been added that prove the fix is effective or that the feature works.
  • New and existing tests pass locally with the changes.
  • Code follows the style guidelines of this project (PEP8, clean code, linter).
  • A self-review of the code has been done.

What is the ticket or issue number?

https://jira.carbonblack.local/browse/CBAPI-5261

Pull Request Description

Rewrite Audit Log guide page to describe the new APIs.

Does this introduce a breaking change?

  • Yes
  • No

How Has This Been Tested?

Docs built and viewed locally to ensure guide page formatting is OK.

Copy link
Contributor

@kebringer-cb kebringer-cb left a comment

Choose a reason for hiding this comment

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

small change to search string, then gtg


.. code-block:: python
# assume "api" contains our CBCloudAPI reference as above
>>> query = api.select(AuditLog).where("description:login")
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of "login", use "Logged in" so it matches actual records.
query = cb.select(AuditLog).where("description:Logged in")

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed in 2 places.

@abowersox-cb abowersox-cb merged commit c0b0149 into feature-audit-logs Apr 26, 2024
4 checks passed
@abowersox-cb abowersox-cb deleted the CBAPI-5261_audit_guide_page branch April 26, 2024 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants