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

Clarify documentation for notification #622

Open
olebhansen opened this issue Oct 4, 2024 · 1 comment
Open

Clarify documentation for notification #622

olebhansen opened this issue Oct 4, 2024 · 1 comment
Assignees
Labels
kind/documentation Improvements or additions to documentation

Comments

@olebhansen
Copy link

olebhansen commented Oct 4, 2024

Task is to (at a minimum) address items from feedback (the same fields/questions might be applicable for multipe endpoints, e.g. item "a"):

Mangelfull API-dokumentasjon, f.eks. https://docs.altinn.studio/notifications/reference/api/openapi/#/Orders/post_orders,

f.eks.
a) Hvilke felt er obligatoriske/valgfrie?
b) Endre fra string til fatisk innhold?, f.eks.
"organizationNumber": "9siffer",
"nationalIdentityNumber": "11siffer",
c) conditionEndpoint; URL til endepunkt som kun returnerer true/false?
d) notificationChannel": "Email" i eksempel; men hva er enum?
e) emailTemplate.contentType: "Plain"i eksempel; men hva er enum?
f) emailTemplate.contentType": "Html", hvilke tags er tillatt brukt (whitelist)?

@olebhansen olebhansen added the kind/documentation Improvements or additions to documentation label Oct 4, 2024
@Ahmed-Ghanam
Copy link
Contributor

I have recently updated the Notification API documentation, covering most of the points outlined in this ticket. However, additional work is needed to fully meet all the specified requirements.

To avoid merge conflicts, I will move this ticket to the backlog. Once the changes are approved, I will reopen it and complete the remaining points.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants