Skip to content

Fix orderBy parameter format in documentation#49

Merged
felipefdl merged 1 commit into
mainfrom
fix/documentation-parameters
Aug 4, 2025
Merged

Fix orderBy parameter format in documentation#49
felipefdl merged 1 commit into
mainfrom
fix/documentation-parameters

Conversation

@mateuscardosodeveloper
Copy link
Copy Markdown
Contributor

Problem

Documentation examples contained invalid parameter formats that would cause runtime errors when copied by users. Issue #38 reported that orderBy parameter examples used incorrect string format instead of list format, and JavaScript false instead of Python False.

Investigation

  • Documentation showed orderBy: "name,asc" but API expects ["name", "asc"] format
  • Examples used false (JavaScript) instead of False (Python)
  • Affected multiple modules: Analyses, Devices, Dashboards
  • Both code examples and RST documentation had inconsistent formats

Solution

  • Updated all orderBy examples to use proper list format ["field", "direction"]
  • Replaced false with False in Python boolean examples
  • Standardized parameter formats across documentation and code examples
  • Fixed examples in Common_Type.py, all Resources modules, and RST documentation

Fixes #38

- Fix orderBy parameter format from string to array format in all examples
- Fix resolveBucketName from lowercase false to Python boolean False
- Update documentation examples to match proper Python syntax
@mateuscardosodeveloper mateuscardosodeveloper added documentation Improvements or additions to documentation bug Something is broken labels Aug 4, 2025
@felipefdl felipefdl merged commit a46a6f8 into main Aug 4, 2025
6 checks passed
@felipefdl felipefdl deleted the fix/documentation-parameters branch August 4, 2025 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something is broken documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

orderBy parameter is invalid

2 participants