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

API Wiki is a bit confusing due to markup #1252

Open
susanodd opened this issue May 29, 2024 · 4 comments
Open

API Wiki is a bit confusing due to markup #1252

susanodd opened this issue May 29, 2024 · 4 comments
Assignees

Comments

@susanodd
Copy link
Collaborator

I noticed that the Create Gloss API endpoint isn't shown in the wiki, but examples of it are shown in the examples section.

I can't recall whether the Create Gloss used to be included or not. When editing in the markup, you edit the entire text and need to scroll endlessly to find things, all written in the markup syntax.
I worry things are going to be deleted by accident this way.

@susanodd
Copy link
Collaborator Author

I added a section for Create Gloss.
And I filled in the "to do" areas.

@susanodd
Copy link
Collaborator Author

susanodd commented May 30, 2024

What to do about API input field syntax?
Should this be yet another API page?
For updating the morphology, I made an additional endpoint, since these are relations, not merely fields.

/dictionary/api_update_gloss_morphology/[datasetid]/[glossid]/

The following can be updated now (on signbank-dev):

  1. Sequential Morphology (gloss annotations separated by plus surrounded by spaces: +

GLOSS1 + GLOSS2 + GLOSS3

  1. Simultaneous Morphology (morpheme annotations separated by comma followed by space: ,

MORPHEME1:meaning1, MORPHEME2:meaning2

  1. Blend Morphology (gloss annotations separated by comma followed by space: ,

GLOSS1:role2, GLOSS2:role2

@Woseseltops
Copy link
Collaborator

I added a section for Create Gloss. And I filled in the "to do" areas.

Great, looks good to me. Does that mean this issue is finished already?

What to do about API input field syntax?
Should this be yet another API page?

I'm not sure how this would be different from what is already here... let's discuss when we see each other face to face

@susanodd
Copy link
Collaborator Author

susanodd commented Jun 5, 2024

I added a section for Create Gloss. And I filled in the "to do" areas.

Great, looks good to me. Does that mean this issue is finished already?

What to do about API input field syntax?
Should this be yet another API page?

I'm not sure how this would be different from what is already here... let's discuss when we see each other face to face

I'm not sure. Maybe it needs more pages so they show up in the right-hand bar?
I also think the syntax of the parameters is confusing.

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

No branches or pull requests

2 participants