Service properties are meta data that can be associated to each service.

You can add them directly in the description of your service

service Employee{
    label: "HR - Employee service"
    urlExternalDescription: ""
    expose employees{
        route employee


Standard Service properties :

  • label (String)
    • short description of the service
  • description (String)
    • description of the service
  • comment (String)
    • Allows you to add a comment to the service
  • urlExternalDescription (String)
    • url pointing to an external description of the service
  • url (String)
    • service url (root of resources url)


These properties are used by Akwatype during the different generations (Graphs, OpenAPI, Excel ...).

note : Premium plan allows you to create and use your own custom properties in addition to the standard akwatype properties.