Skip to content

Conversation

@buger
Copy link
Member

@buger buger commented Nov 19, 2025

User description

📚 Documentation Merge Summary

This PR contains automatically merged documentation from multiple branches.

Triggered by:

Deployment Details:

  • Generated from: branches-config.json
  • Run ID: 19499556813
  • Subfolder: (root deployment)
  • Timestamp: $(date)

Changes Include:

  • ✅ Merged documentation from multiple branches
  • ✅ Generated unified docs.json configuration
  • ✅ Updated assets and content structure
  • ✅ Cleaned up outdated version folders

🚦 This PR will be processed by merge queue to ensure proper validation and ordering.

Previous deployment PRs have been automatically closed to prevent conflicts.


PR Type

Documentation


Description

  • Standardize audit date format to YYYY-MM-DD

  • Update from_date and to_date examples

  • Apply changes across 5.8, 5.10, nightly specs


Diagram Walkthrough

flowchart LR
  Swagger510["dashboard-swagger.yml (5.10)"]
  Swagger58["dashboard-swagger.yml (5.8)"]
  SwaggerNightly["dashboard-swagger.yml (nightly)"]
  Params["from_date / to_date params"]
  ISO["Format: YYYY-MM-DD with ISO examples"]

  Swagger510 -- update --> Params
  Swagger58 -- update --> Params
  SwaggerNightly -- update --> Params
  Params -- clarify --> ISO
Loading

File Walkthrough

Relevant files
Documentation
dashboard-swagger.yml
Align 5.10 audit date params to ISO                                           

swagger/5.10/dashboard-swagger.yml

  • Change from_date format to YYYY-MM-DD.
  • Update from_date example to 1990-11-25.
  • Change to_date format to YYYY-MM-DD.
  • Update to_date example to 2030-12-18.
+4/-4     
dashboard-swagger.yml
Align 5.8 audit date params to ISO                                             

swagger/5.8/dashboard-swagger.yml

  • Set from_date format to YYYY-MM-DD.
  • Example updated to 1990-11-25.
  • Set to_date format to YYYY-MM-DD.
  • Example updated to 2030-12-18.
+4/-4     
dashboard-swagger.yml
Align nightly audit date params to ISO                                     

swagger/nightly/dashboard-swagger.yml

  • Specify from_date as YYYY-MM-DD.
  • Example updated to 1990-11-25.
  • Specify to_date as YYYY-MM-DD.
  • Example updated to 2030-12-18.
+4/-4     

Generated from branches-config.json at

- Merged documentation from multiple branches
- Generated unified docs.json
- Updated assets and content structure
@buger buger added auto-deployment automated documentation Improvements or additions to documentation labels Nov 19, 2025
@buger buger enabled auto-merge (squash) November 19, 2025 11:22
@github-actions
Copy link

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Add OpenAPI date format

Since the format is ISO date (YYYY-MM-DD), declare the parameters as format: date to
ensure correct validation and tooling support. This avoids clients sending non-date
strings and improves generated SDK types.

swagger/5.10/dashboard-swagger.yml [9410-9423]

 - 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: 1990-11-25
   in: query
   name: from_date
   required: false
   schema:
     type: string
+    format: date
 - 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: 2030-12-18
   in: query
   name: to_date
   required: false
   schema:
+    type: string
+    format: date
Suggestion importance[1-10]: 7

__

Why: Adding format: date to the string schema for from_date and to_date aligns with the new YYYY-MM-DD spec and improves validation/tooling. The snippet matches the new hunk and the improved code correctly reflects the change.

Medium
Specify OpenAPI date format

Explicitly set format: date for these query parameters to align with the documented
YYYY-MM-DD format and prevent ambiguous string inputs. This ensures validators and
code generators treat them as calendar dates.

swagger/5.8/dashboard-swagger.yml [9396-9408]

 - 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: 1990-11-25
   in: query
   name: from_date
   required: false
   schema:
     type: string
+    format: date
 - 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: 2030-12-18
   in: query
   name: to_date
   required: false
   schema:
+    type: string
+    format: date
Suggestion importance[1-10]: 7

__

Why: Using format: date is appropriate for the documented YYYY-MM-DD inputs and benefits validators/SDKs. The existing code maps to the new hunk range and the proposed change is accurate and low-risk.

Medium
Use proper date format

Define format: date for both parameters to match ISO date expectations and improve
schema validation across environments and generated clients.

swagger/nightly/dashboard-swagger.yml [9410-9422]

 - 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: 1990-11-25
   in: query
   name: from_date
   required: false
   schema:
     type: string
+    format: date
 - 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: 2030-12-18
   in: query
   name: to_date
   required: false
   schema:
+    type: string
+    format: date
Suggestion importance[1-10]: 7

__

Why: Declaring format: date for these query params improves schema precision and client generation, matching the updated description. The code snippet corresponds to the new hunk and the improved code is consistent.

Medium

@buger buger merged commit 1eca9bd into production Nov 19, 2025
5 checks passed
@buger buger deleted the docs-merge-429 branch November 19, 2025 11:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-deployment automated documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants