feat: create_highlight

[Benature]

Closes #IssueNr

📑 Description

add a method create_highlight

✅ Checks

• My pull request adheres to the code style of this project
• My code requires changes to the documentation
• I have updated the documentation as required
• All the tests have passed

ℹ Additional Information

Summary by Sourcery

New Features:

• Adds a create_highlight method to create highlights for articles.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces the functionality to create highlights via a new create_highlight method in the OmnivoreQL class, backed by a new GraphQL mutation and fragment.

Sequence diagram for create_highlight

sequenceDiagram
    participant Client
    participant OmnivoreQL
    participant GraphQL API

    Client->>OmnivoreQL: create_highlight(article_id, annotation, highlight_type)
    OmnivoreQL->>GraphQL API: execute(CreateHighlight, variables)
    GraphQL API-->>OmnivoreQL: Response
    OmnivoreQL-->>Client: Response

Loading

Updated class diagram for OmnivoreQL

classDiagram
  class OmnivoreQL {
    +create_highlight(article_id: str, annotation: str, highlight_type: Literal[\'HIGHLIGHT\', \'NOTE\'])
  }

Loading

File-Level Changes

Change	Details	Files
Added a GraphQL mutation and fragment for creating highlights.	Added CreateHighlight.graphql with a mutation to create highlights. Added HighlightFields fragment to retrieve highlight details.	omnivoreql/queries/CreateHighlight.graphql
Implemented the create_highlight method in the OmnivoreQL class.	Added create_highlight method to OmnivoreQL class. The method takes article_id, annotation, and highlight_type as parameters. It executes the CreateHighlight GraphQL mutation with the provided input. A UUID is generated for the highlight ID and a short UUID for the short ID.	omnivoreql/omnivoreql.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @Benature - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider generating the shortId and UUID on the server side to avoid potential conflicts.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[Benature]

I'm afraid not. id and shortId is required

Here's the server log of omnivore-api

Field "id" of required type "ID!" was not provided.
Field "shortId" of required type "String!" was not provided.