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

Symbol Translator #47

Merged
merged 12 commits into from
Dec 5, 2024
Merged

Symbol Translator #47

merged 12 commits into from
Dec 5, 2024

Conversation

daghovland
Copy link
Contributor

@daghovland daghovland commented Dec 2, 2024

AB#188605

Aim of the PR

Make the mapping from symbol name to label attributes available as JSON for the frontend.
The assumption/decision is that the symbol-library is read by the frontend, and not during translation on reception by backend

Implementation

Created a minimal asp.net web api with a single endpoint that takes a DEXPI symbol ID as its only argument and returns a json structure like this

{
  "id" : "ND0028",
  "description" : "Flow in nozzle",
  "labelAttributeA" : "<ObjectDisplayName>",
  "labelAttributeB" : "",
  "labelAttributeC" : "",
  "labelAttributeD" : "",
  "labelAttributeE" : ""
}

Also a dockerized version is made, which is now part of the docker compose setup. Test the project by starting docker compose as usual, described in docker/README.md

Type of change

  • Bug fix
  • New feature
  • Breaking change
  • This change requires a documentation update

If the changes impact any dependent services then provide details.

How Has This Been Tested?

There are github actions that test the labels A, B and C
The docker setup has been tried

Open Questions

I am not sure if this is all data that is needed for the frontend, or if the format is suitable for consumption by the frontend.

Copy link
Contributor

@eoye eoye left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very cool! Good documentation that is clear and understandable, so it was easy to test. I tested out the API and was able to get label attributes for symbol PF009A. I also tested the project by starting docker compose, and everything works👍
Nice work with the tests✔
I can't think of any other data that is needed for the frontend right now. The format looks okay to use in the frontend.

@daghovland daghovland merged commit 4ff13f8 into main Dec 5, 2024
2 checks passed
@eoye eoye deleted the story/188605-symbol-library-json branch December 11, 2024 13:27
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

Successfully merging this pull request may close these issues.

2 participants