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

Add documentation on the URL structure for deeplinking📘 #2553

Open
1 of 4 tasks
eliasbruvik opened this issue Sep 19, 2024 · 0 comments
Open
1 of 4 tasks

Add documentation on the URL structure for deeplinking📘 #2553

eliasbruvik opened this issue Sep 19, 2024 · 0 comments
Labels
Documentation Improvements or additions to documentation High Priority

Comments

@eliasbruvik
Copy link
Contributor

**Documentation Is:📘 **

  • Missing
  • Needed
  • Confusing
  • Not Sure?

Please Explain in Detail

We should add documentation about the structure of the URL so that it is easy for developers to create deep links from other applications directly to a well/wellbore/object/curve data etc.

We also need to document what search params (if any) are available for each route, including the format if the param requires a specific format.

Your Proposal for Changes

For example, this is what the url looks like for the curve values view:
/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects/:objectUid/curvevalues?startIndex=<startIndex>&endIndex=<endIndex>&mnemonics=<mnemonics>

We also need to specify the possible values for any enum such as objectGroup and logType in this case.

@eliasbruvik eliasbruvik added Documentation Improvements or additions to documentation High Priority labels Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation High Priority
Projects
Development

No branches or pull requests

1 participant