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.

Sign up for GitHub

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

Jump to bottom

API V2: Documentation #170

Open
CamilleLetavernier opened this issue Feb 15, 2022 · 4 comments
Open

API V2: Documentation #170

CamilleLetavernier opened this issue Feb 15, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request modelserver EMF.cloud Model Server sponsored v2

Comments

@CamilleLetavernier
Copy link
Member

This is a follow-up for #151

Once the API V2 is ready, we should provide documentation (New features, changes compared to V1).

Main topics to cover:

  • New Json Codec (eClass => $type, $id attribute, ...)
  • New Commands parameters (Either EMF CCommand or Json Patch)
  • Updated endpoints (PATCH /edit => PATCH /models, PATCH /models => PUT /models, ...)
  • Json Patch notifications for incremental updates
  • Transactions
  • ...
@CamilleLetavernier CamilleLetavernier added enhancement New feature or request modelserver EMF.cloud Model Server labels Feb 15, 2022
@ndoschek ndoschek added the documentation Improvements or additions to documentation label Feb 15, 2022
@ndoschek
Copy link
Contributor

ndoschek commented Feb 15, 2022 •
edited
Loading

It would be great to offer API documentation for example via the Javalin OpenAPI plugin and V2 would be definitely a great starting point to do so.

@martin-fleck-at
Copy link
Contributor

Since the plan is to replace V1 in the long run I think it would be great if we could also provide a migration guide from V1 to V2 as part of this task.

@ndoschek ndoschek mentioned this issue Feb 28, 2022
Merged
@martin-fleck-at
Copy link
Contributor

The README should also be adapted as part of this task, see #151 (comment)

@martin-fleck-at
Copy link
Contributor

Current online documentation is available at https://www.eclipse.org/emfcloud/documentation/

@ndoschek ndoschek added the v2 label Aug 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request modelserver EMF.cloud Model Server sponsored v2
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@eneufeld @CamilleLetavernier @martin-fleck-at @ndoschek