docs.konghq.com icon indicating copy to clipboard operation
docs.konghq.com copied to clipboard

docs(api): define ordering of audit log requests

Open nowNick opened this issue 10 months ago • 7 comments

Description

Audit Log request were previously sorted by request_id. With the upcoming changes they'll be sorted by request_timestamp descending - which is from latest to oldest.

Testing instructions

Preview link:

Checklist

nowNick avatar Apr 05 '24 07:04 nowNick

Deploy Preview for kongdocs ready!

Name Link
Latest commit 338b987dd1555397239dc129a5ca654a515a08aa
Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/663bc0b1c7235a00088b40cc
Deploy Preview https://deploy-preview-7178--kongdocs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

Lighthouse
9 paths audited
Performance: 92 (🔴 down 1 from production)
Accessibility: 93 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 91 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Apr 05 '24 07:04 netlify[bot]

Hey @lena-larionova !

I was hoping I could preview the change here: https://deploy-preview-7178--kongdocs.netlify.app/gateway/api/admin-ee/latest/#/audit-logs/get-audit-requests but I think the conditional version tag is excluding it since the latest version there is 3.6.0.x and I'm allowing it only for: {% if_version gte:3.7.x %}

Is that expected?

nowNick avatar Apr 18 '24 16:04 nowNick

Ah! I'm sorry, I didn't realize this was one of the migrated pages, that's my miss. You will actually have to update the spec instead now: https://github.com/Kong/docs.konghq.com/blob/main/api-specs/Gateway-EE/latest/kong-ee.yaml#L14781

You don't need to version tag anything in the spec, we'll cut a new version when 3.7 goes out.

lena-larionova avatar Apr 18 '24 16:04 lena-larionova

Got it! I'll fix that but for now I'll change this PR back to draft.

nowNick avatar Apr 18 '24 16:04 nowNick

@lena-larionova I've updated the spec but I still can't see it in deploy preview : https://deploy-preview-7178--kongdocs.netlify.app/gateway/api/admin-ee/latest/#/audit-logs Shouldn't it be visible there? 🤔

nowNick avatar Apr 25 '24 11:04 nowNick

@lena-larionova I've updated the spec but I still can't see it in deploy preview : https://deploy-preview-7178--kongdocs.netlify.app/gateway/api/admin-ee/latest/#/audit-logs Shouldn't it be visible there? 🤔

We have to upload the spec to the konnect dev portal, which is currently not automated. I'll upload it after this PR gets merged.

lena-larionova avatar Apr 26 '24 18:04 lena-larionova

Threw it into swagger editor to test, everything displays as it should. Will merge with 3.7.

lena-larionova avatar Apr 26 '24 18:04 lena-larionova

Pulled all of these changes into #7353 so they can be merged with the release of 3.7. Closing this PR.

Guaris avatar May 08 '24 18:05 Guaris