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: Flesh out result in GET_NOTES and GET_OVERRIDES #2175

Merged
merged 1 commit into from
Apr 23, 2024

Conversation

mattmundell
Copy link
Contributor

What

Add summary and details to the result attribute in the GMP docs for GET_NOTES and GET_OVERRIDES.

Why

Clarity.

Before PR:

7.59.1 Structure
    @result (boolean)

after PR:

7.59.1 Structure
  Command
    @result (boolean) Whether to include the associated result.
      More Details
        Requires "details" to be true.

Here's the associated GMP:

$ o m m '<get_notes filter="rows=1"/>'
<get_notes_response status="200" status_text="OK">
  <note id="4ca00487-2c6a-4eeb-a645-dbebb6aa956a">
$ o m m '<get_notes details="1" filter="rows=1"/>'
<get_notes_response status="200" status_text="OK">
  <note id="4ca00487-2c6a-4eeb-a645-dbebb6aa956a">
    <result id="e7ef79c7-6252-4787-9a1f-64e672620ce7" />

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

Conventional Commits Report

Type Number
Changed 1

🚀 Conventional commits found.

@bjoernricks bjoernricks merged commit f70710b into main Apr 23, 2024
9 checks passed
@bjoernricks bjoernricks deleted the gmp-doc-get-notes-result branch April 23, 2024 07:19
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