Skip to content

OpenAPI Specs: Update /db/_config/audit endpoint body format #6963

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

Merged
merged 1 commit into from
Jul 16, 2024

Conversation

bbrks
Copy link
Member

@bbrks bbrks commented Jul 15, 2024

Update /db/_config/audit format to match changes made in #6940 (events nested under "events" property, "enabled" exposed)

Screenshot 2024-07-15 at 13 56 42

Integration Tests

  • n/a

Copy link

Redocly previews

@bbrks bbrks requested a review from torcolvin July 16, 2024 13:10
additionalProperties:
x-additionalPropertiesName: audit_id
description: The audit event ID and whether it is enabled or not.
type: boolean
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this worth adding an example for the format? I am somewhat confused by why this is map[string]any and then it is actually map[string]bool?

Copy link
Member Author

@bbrks bbrks Jul 16, 2024

Choose a reason for hiding this comment

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

The PUT/POST endpoint accepts both verbose and non-verbose formats (without specifying the ?verbose=true query param)

This is displayed correctly for both cases in the Redocly UI with a dropdown to select the type of body format.

Screenshot 2024-07-16 at 19 21 29
Screenshot 2024-07-16 at 19 21 32

@torcolvin torcolvin assigned bbrks and unassigned torcolvin Jul 16, 2024
@bbrks bbrks assigned torcolvin and unassigned bbrks Jul 16, 2024
@torcolvin torcolvin enabled auto-merge (squash) July 16, 2024 18:23
@torcolvin torcolvin merged commit 0bc1d67 into main Jul 16, 2024
22 checks passed
@torcolvin torcolvin deleted the update_api_docs_audit_logging branch July 16, 2024 18:23
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.

2 participants