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

Make it possible to post related events #786

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

gchpaco
Copy link

@gchpaco gchpaco commented Jul 18, 2023

The current version of dogshell interprets --related_event_id as a string, not an integer, which means the backend refuses to work with it. The fix is simple; to tell argparse that it's an int.

Requirements for Contributing to this repository

  • Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
  • The pull request must only fix one issue, or add one feature, at the time.
  • The pull request must update the test suite to demonstrate the changed functionality.
  • After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see CONTRIBUTING.

What does this PR do?

Fix #785 by adding typing to related event IDs in argparse.

Description of the Change

To ensure that the JSON API is sent an integer and not a string, we add type=int to the relevant argparse declaration.

Alternate Designs

You could do it at the call site, or otherwise parse it, but argparse makes this relatively easy.

Possible Drawbacks

If you were in the habit of posting random garbage to related event ID and expecting it to fail, it will now fail slightly earlier.

Review checklist (to be filled by reviewers)

  • Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
  • PR should not have do-not-merge/ label attached.
  • If Applicable, issue must have kind/ and severity/ labels attached at least.

The current version of `dogshell` interprets `--related_event_id` as a string, not an integer, which means the backend refuses to work with it.  The fix is simple; to tell argparse that it's an int.
@gchpaco gchpaco requested a review from a team as a code owner July 18, 2023 16:55
@github-actions
Copy link

This issue has been automatically marked as stale because it has not had activity in the last 30 days.
Note that the issue will not be automatically closed, but this notification will remind us to investigate why there's been inactivity.

@github-actions github-actions bot added the stale Stale - Bot reminder label Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale Stale - Bot reminder
Projects
None yet
Development

Successfully merging this pull request may close these issues.

dog event post does not type --related_event_id properly
1 participant