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

✨ webapi: new descriptionUI flag to render service a single page UI πŸ—ƒοΈ #6290

Merged

Conversation

pcrespov
Copy link
Member

@pcrespov pcrespov commented Sep 2, 2024

What do these changes do?

A new flag descriptionUi (in web-api response v0.42.0 β†’ v0.43.0) or description_ui (in pg table) on the service meta-data that determines how the description markdown is rendered in the UI (i.e. the service tiles). Specifically, it indicates whether the description should be presented as a single web page (=true) or in another structured format (default=false). This field is primarily used by the front-end of the application to decide on the presentation style of the service's metadata.

Highlights

  • new column description_ui in pg database
  • new field in service metadata models returned in get and input parameter for update operations in catalog rpc-api
  • new field in service metadata models responses in GET and body of PATCH for webserver rest-api (v0.42.0 β†’ v0.43.0)

Related issue/s

How to test

in place

Dev-ops checklist

@pcrespov pcrespov self-assigned this Sep 2, 2024
@pcrespov pcrespov added a:webserver issue related to the webserver service a:catalog catalog service labels Sep 2, 2024
Copy link

codecov bot commented Sep 2, 2024

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 88.1%. Comparing base (cafbf96) to head (14c5fa7).
Report is 496 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##           master   #6290      +/-   ##
=========================================
+ Coverage    84.5%   88.1%    +3.5%     
=========================================
  Files          10    1477    +1467     
  Lines         214   61114   +60900     
  Branches       25    2063    +2038     
=========================================
+ Hits          181   53873   +53692     
- Misses         23    6926    +6903     
- Partials       10     315     +305     
Flag Coverage Ξ”
integrationtests 64.8% <ΓΈ> (?)
unittests 86.1% <100.0%> (+1.5%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Ξ”
...src/models_library/api_schemas_catalog/services.py 100.0% <100.0%> (ΓΈ)
...models-library/src/models_library/services_base.py 100.0% <100.0%> (ΓΈ)
...y/src/models_library/services_metadata_editable.py 100.0% <100.0%> (ΓΈ)
.../src/models_library/services_metadata_published.py 100.0% <ΓΈ> (ΓΈ)
...e/src/simcore_postgres_database/models/services.py 100.0% <100.0%> (ΓΈ)
...e_service_catalog/db/repositories/_services_sql.py 100.0% <ΓΈ> (ΓΈ)
...imcore_service_catalog/db/repositories/services.py 83.5% <ΓΈ> (ΓΈ)
.../src/simcore_service_catalog/models/services_db.py 100.0% <100.0%> (ΓΈ)
...c/simcore_service_catalog/services/services_api.py 92.0% <ΓΈ> (ΓΈ)

... and 1421 files with indirect coverage changes

@pcrespov pcrespov added this to the Eisbock milestone Sep 2, 2024
@pcrespov pcrespov changed the title ✨ Is5476/service wiki enabled flag ✨ new descriptionUI flag to render service a single page UI Sep 2, 2024
@pcrespov pcrespov changed the title ✨ new descriptionUI flag to render service a single page UI ✨ webapi: new descriptionUI flag to render service a single page UI Sep 2, 2024
@pcrespov pcrespov requested a review from odeimaiz September 2, 2024 21:44
@pcrespov pcrespov marked this pull request as ready for review September 2, 2024 21:44
@pcrespov pcrespov enabled auto-merge (squash) September 2, 2024 21:48
Copy link
Member

@odeimaiz odeimaiz left a comment

Choose a reason for hiding this comment

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

Thanks πŸ‘

Copy link
Member

@sanderegg sanderegg left a comment

Choose a reason for hiding this comment

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

thanks. a few thoughts

Copy link

sonarqubecloud bot commented Sep 3, 2024

@pcrespov pcrespov merged commit 7550a9c into ITISFoundation:master Sep 3, 2024
68 checks passed
@matusdrobuliak66 matusdrobuliak66 changed the title ✨ webapi: new descriptionUI flag to render service a single page UI ✨ webapi: new descriptionUI flag to render service a single page UI πŸ—ƒοΈ Sep 3, 2024
@pcrespov pcrespov deleted the is5476/service-wiki_enabled-flag branch September 4, 2024 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:catalog catalog service a:webserver issue related to the webserver service
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants