Skip to content
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

Change: GMP doc: remove option timezone from GET_RESULTS #2168

Merged
merged 1 commit into from
Apr 15, 2024

Conversation

mattmundell
Copy link
Contributor

@mattmundell mattmundell commented Apr 14, 2024

What

Remove the timezone option from GET_RESULTS in the GMP doc.

Why

There is no such option. For example:

$ o m m '<get_results details="1" filter="rows=1 timezone=UTC"/>'
<get_results_response status="200" status_text="OK">
  <result id="3e3abe2e-1626-4b16-8812-d27ffd568e9f">
    <creation_time>2023-10-02T22:24:26+02:00</creation_time>

Note the +02:00 on the time. It is the same without the option:

$ o m m '<get_results filter="rows=1"/>'
<get_results_response status="200" status_text="OK">
  <result id="3e3abe2e-1626-4b16-8812-d27ffd568e9f">
    <creation_time>2023-10-02T22:24:26+02:00</creation_time>

References

Looks like Timo accidentally added this in 587584b, probably because GET_RESULTS is very similar to GET_REPORTS. However, GET_REPORTS is calling manage_report_filter_controls (in print_report_xml_start) with a return zone argument, whereas GET_RESULTS is calling manage_report_filter_controls (in handle_get_results) with a NULL zone argument.

So GET_REPORTS accepts the timezone option, for example:

o m m '<get_reports details="1" report_id="4b4bd3dc-cf4c-4c6d-8f5c-83384c95ed3f" filter="rows=1 timezone=UTC"/>'
<get_reports_response status="200" status_text="OK">
        <result id="3e3abe2e-1626-4b16-8812-d27ffd568e9f">
          <creation_time>2023-10-02T20:24:26Z</creation_time>

Note the Z in the time.

@mattmundell mattmundell requested a review from a team as a code owner April 14, 2024 21:18
Copy link

Conventional Commits Report

Type Number
Changed 1

🚀 Conventional commits found.

@bjoernricks bjoernricks merged commit 8ce9c50 into main Apr 15, 2024
9 checks passed
@bjoernricks bjoernricks deleted the gmp-doc-get-results-tz branch April 15, 2024 07:06
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