Skip to content

Add custom request types

Pavlos Karakalidis requested to merge pkarakal/universis-students:456-request-types into master

What does this MR do?

This defines a new interface IRequestTypesConfiguration which custom request types have to implement. When populating the requests, RequestsService will also be searching the application configuration for custom requests. If it finds, it will add them under their category. If it doesn't find any, it will return an empty array

Deployment Instructions

If you want to deploy some custom requests, you have to add the following in your app.production.json

"settings": {
    "app": {
      ...
      "requests": [
        {
          "name": "<display name of your request",
          "alternateName": "<alternate name of your request. add this in english>",
          "category": "<category>", (type of requests (eg. Certificates, Requests)
          "entryPoint": "</path/to/component", (relative to root /`
          "description"?: "<Description>", (optional)
          "inLanguage"?: "<language>", (optional) (should be one of the locales defined in your `i18n.locales`
          "additionalType"?: "<additionalType>" (optional)
        }
      ]
    },

If you want to add the same request in more than one languages, you have to add it in all the languages you wish that request to be available.

Related issues and links

Fix #456 (closed)

Developer Checklist

  • I have successfully run the code of this merge request locally

  • I have verified locally that my changes work for all necessary screen sizes

  • I have tried out the changes of this MR with different users to identify bugs

  • Coding is in progress, and I have marked the MR as WIP

  • Coding is completed and the MR is ready for review

  • My branch is up-to-date with the upstream master branch

  • My MR follows the contribution guidelines

  • I have added a comment with screenshots of the code running locally

Tech review Checklist

Have you verified that what is supposed to happen, actually does, and what is not supposed to happen, indeed does not?

  • The MR accurately describes the changes and has a relevant title/description
  • The MR does what it is supposed to according to its title, description and related issues/links
  • I have successfully run the changes locally, and tried the new code

Overall review Checklist

  • The MR references related issues/MRs
  • The MR provides links to screens and screenshots
  • The commits of the MR describe the changes, have proper wording, and follow the guidelines
  • I have successfully run the changes locally, and tried the new code
  • The MR is ready for merge (rebased, commit squashed if needed, etc)

Closes #456 (closed)

Merge request reports