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

Extend API with methods to edit resource text #18

Open
proycon opened this issue Sep 20, 2023 · 0 comments
Open

Extend API with methods to edit resource text #18

proycon opened this issue Sep 20, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@proycon
Copy link
Contributor

proycon commented Sep 20, 2023

The API needs some methods that allow editing a resource's text
(insertion,deletion,substitution). Editing text has consequences for
potentionally all annotations on it as they are referred to by offset. When
text is edited, offsets of other annotations need to adjust automatically. As
this is a fairly expensive operation, I want to implement the ability to
commit a batch of edits at once, so the computation can be done more efficiently.

When text changes and annotations are updated accordingly, the user should have the options of:

  1. Just reusing existing resource and annotation IDs: annotations are forcibly edited. This is fine as long as the resource hasn't been published yet, otherwise discouraged.
  2. Create new resources and new annotations with new IDs (support a version component in the ID): strictly adheres to the idea of annotations being immutable.
    • The old ones may be either retained or deleted
    • If retained, there may be an extra annotation linking the old ones to the new ones
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

No branches or pull requests

1 participant