Skip to content

GH-349: Extend service with a list app definitions endpoint#361

Merged
lucas-koehler merged 1 commit intomainfrom
lk/issues/349-expose-app-defs
Oct 23, 2024
Merged

GH-349: Extend service with a list app definitions endpoint#361
lucas-koehler merged 1 commit intomainfrom
lk/issues/349-expose-app-defs

Conversation

@lucas-koehler
Copy link
Contributor

Changes

App definition endpoint

  • Add AppDefinitionResource with endpoint to list all app definitions. The endpoint is restricted to authenticated users but is still available in anonymous mode

Sensitive data redaction

  • Add SensitiveData annotation to mark properties that should not be serialized publicly by Jackson.
  • Add a corresponding serializer and serializer modifiert for Jackson and register the modifier in the service
  • Add unit tests for the serializer

Javascript API

  • Update openapi.json from service
  • Regenerate api code
  • Add AppDefinitions namespace with function to list app definitions

Testing Page

  • Add button to get app definitions
  • Apply formatting rules to App.tsx by saving it
  • Minor fix in example keycloak URL to remove obsolete /auth

Misc

  • Add mockito dependency to the common maven module

How to test

  • Run service either by building it in Minikube or debugging it
  • Start testing page. Use the List App Definitions button to see the app definitions
  • Ensure the pullSecret properties have value *** which is the redacted value

### App definition endpoint
- Add AppDefinitionResource with endpoint to list all app definitions.
  The endpoint is restricted to authenticated users but is still available in anonymous mode

### Sensitive data redaction
- Add `SensitiveData` annotation to mark properties that should not be serialized publicly by Jackson.
- Add a corresponding serializer and serializer modifiert for Jackson and register the modifier in the service
- Add unit tests for the serializer

### Javascript API
- Update openapi.json from service
- Regenerate api code
- Add AppDefinitions namespace with function to list app definitions

### Testing Page
- Add button to get app definitions
- Apply formatting rules to App.tsx by saving it
- Minor fix in example keycloak URL to remove obsolete `/auth`

### Misc
- Add mockito dependency to the common maven module
@lucas-koehler lucas-koehler linked an issue Oct 22, 2024 that may be closed by this pull request
Copy link
Contributor

@jfaltermeier jfaltermeier left a comment

Choose a reason for hiding this comment

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

Looks good to me. Passwords (and missing passwords) are both shown as ***.
Missing values are displayed as null, which is fine.
Nested objects, like monitor, also look good.
Without keycloak, listing app definitions still works.
With keycloak only logged in users can list app definitions.

I just added one question inline out of curiosity - maybe you have an answer.

@lucas-koehler lucas-koehler merged commit 051f87a into main Oct 23, 2024
@lucas-koehler lucas-koehler deleted the lk/issues/349-expose-app-defs branch October 23, 2024 14:29
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.

Make AppDefinitions more powerful in landing pages

2 participants