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

[ocis] Search: Provide search highlight #6426

Closed
2 tasks
exalate-issue-sync bot opened this issue Jun 1, 2023 · 1 comment · Fixed by #6634
Closed
2 tasks

[ocis] Search: Provide search highlight #6426

exalate-issue-sync bot opened this issue Jun 1, 2023 · 1 comment · Fixed by #6634
Labels
Milestone

Comments

@exalate-issue-sync
Copy link

exalate-issue-sync bot commented Jun 1, 2023

Description

User Stories

  • As a user who searches within file content for a keyword, I want to see some context besides the keyword so that I can easily find the right file.

Value

Helps the user to better find the desired file.

Acceptance Criteria

  • The ocis Server and clients agree on a way to send/receive highlighted content
  • The ocis Server sends the search highlights in the search response

Example from oc 10

oc10 uses a GET requests against the search endpoint. For ocis, we are using a WebDAV REPORT Request. The returned payload is json

[
    {
        "type": "search_elastic",
        "score": 9.5190889999999992,
        "highlights": [
            "ownCloud \u003Cem\u003EUser\u003C\/em\u003E \u003Cem\u003EManual\u003C\/em\u003E\n\nThe ownCloud Team\n\nVersion 10.2, July 02, 2019\n\n\n\nTable of Contents\n\nIntroduction",
            "If you prefer to mount\nit \u003Cem\u003Emanually\u003C\/em\u003E, change auto to noauto in \/etc\/fstab.",
            "Its usage is documented separately in the ownCloud Desktop Client \u003Cem\u003EManual\u003C\/em\u003E.",
            "Visit the ownCloud documentation page to read the mobile apps \u003Cem\u003Euser\u003C\/em\u003E \u003Cem\u003Emanuals\u003C\/em\u003E.",
            ".....WebUI Overview"
        ],
        "path": "\/..../end-user\/user manual.pdf",
        "size": 5011365,
        "modified": 1571860243,
        "mime_type": "application\/pdf",
        "permissions": "27",
        "id": "5020373",
        "name": "user manual.pdf",
        "link": "\/index.php\/apps\/files\/?dir=\/....&scrollto=user%20manual.pdf"
    }
]

Definition of ready

[ ] everybody needs to understand the value written in the user story
[ ] acceptance criteria has to be defined
[ ] all dependencies of the user story need to be identified
[ ] feature should be seen from an end user perspective
[ ] user story has to be estimated
[ ] story points need to be less then 20

Definition of done

  • Functional requirements
    [ ] functionality described in the user story works
    [ ] acceptance criteria are fulfilled
  • Quality
    [ ] code review happened
    [ ] CI is green
    [ ] critical code received unit tests by the developer
    [ ] automated tests passed (if automated tests are not available, this test needs to be created and passed
  • Non-functional requirements
    [ ] no sonar cloud issues
@tbsbdr
Copy link

tbsbdr commented Jun 1, 2023

@aduffeck could you please provide infos how web can gather these infos for @kulmann and @JammingBen ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants