[DX-2168] Fix Invalid Date Format Specified for Dashboard List Audit Logs API

[sharadregoti]

PR Type

Documentation

---

Description

• Correct audit log date format docs

• Align from_date and to_date descriptions

• Clarify expected YYYY-MM-DD format

---

Diagram Walkthrough

flowchart LR
  Swagger["Dashboard Swagger YAML"]
  Params["from_date and to_date query params"]
  Format["Document format: YYYY-MM-DD"]

  Swagger -- updates --> Params
  Params -- clarify --> Format

Loading

File Walkthrough

	Relevant files
Documentation	dashboard-swagger.yml Standardize audit date format documentation                            swagger/dashboard-swagger.yml Update from_date description to YYYY-MM-DD. Update to_date description to YYYY-MM-DD. Keep examples unchanged (still DD-MM-YYYY). +2/-2

---

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Example Mismatch The descriptions specify format YYYY-MM-DD but the provided examples use DD-MM-YYYY (e.g., 01-01-1990). Ensure examples align with the documented format to avoid confusion and client generation issues. - description: Specifies the start date for the audit log search. If not provided, the search will include records from the earliest available date. Format YYYY-MM-DD. example: 01-01-1990 in: query name: from_date required: false schema: type: string - description: Specifies the end date for the audit log search. If not provided, the search will include records up to the current date and time. Format YYYY-MM-DD. example: 01-01-2030

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Fix example date format The example date still uses DD-MM-YYYY while the description specifies YYYY-MM-DD. Align the example to the documented format to prevent client confusion and validation mismatches. swagger/dashboard-swagger.yml [9410-9416] - description: Specifies the start date for the audit log search. If not provided, the search will include records from the earliest available date. Format YYYY-MM-DD. - example: 01-01-1990 + example: 1990-01-01 in: query name: from_date required: false schema: type: string Suggestion importance[1-10]: 7 __ Why: The PR changes the format to YYYY-MM-DD but the example remains 01-01-1990; aligning the example to 1990-01-01 prevents confusion and tooling issues. The existing_code maps to the new hunk content for from_date.	Medium
	Correct end date example The example contradicts the specified format; update it to match YYYY-MM-DD to avoid misimplementation by API consumers and automated generators. swagger/dashboard-swagger.yml [9417-9421] - description: Specifies the end date for the audit log search. If not provided, the search will include records up to the current date and time. Format YYYY-MM-DD. - example: 01-01-2030 + example: 2030-01-01 in: query name: to_date required: false Suggestion importance[1-10]: 7 __ Why: Similarly, the to_date example conflicts with the stated YYYY-MM-DD format; updating to 2030-01-01 improves consistency and reduces consumer errors. The snippet correctly targets the new hunk lines.	Medium

[sharadregoti]

Approved https://github.com/TykTechnologies/tyk-analytics/pull/5065

[buger]

/release to release-5.8

[buger]

/release to release-5.10

[github-actions]

✅ Cherry-pick successful. A PR was created and auto-merged (if allowed): #982

[github-actions]

✅ Cherry-pick successful. A PR was created and auto-merged (if allowed): #983