Skip to content

kaskadi/apps-api

Repository files navigation

GitHub Actions workflows status

Deploy status Build status Docs generation status

CodeClimate


API endpoints

The origin and root path for this API is: https://api.klimapartner.net/apps

The following endpoints are defined in this API:

/

Supported methods:

GET (target lambda → get-apps)

Description:

This endpoint lists all applications available for the Kaskadi project.

Authorization:

No authorizer found for this method.

Query string parameters:

No query string parameters found for this method.

Request body:

No body found for this method.

Examples:

Example #1

Request:

GET https://api.klimapartner.net/apps/

Response:

Status code:
  200

Headers:
  Access-Control-Allow-Origin: *

Body:
  [
    {
      "listed": true,
      "title": {
        "en": "Accounting",
        "de": "Buchhaltung",
        "fr": "Comptabilité"
      },
      "section": "finance",
      "main": "kaskadi-accounting.js",
      "description": {
        "en": "Accounting app",
        "de": "Buchhaltung",
        "fr": "Application pour la comptabilité"
      },
      "routes": [
        {
          "path": "/finance/accounting",
          "appPath": "/modules/@kaskadi/kaskadi-apps/kaskadi-accounting/kaskadi-accounting.js"
        }
      ]
    },
    {
      "listed": false,
      "title": {
        "en": "APP-TITLE-ENGLISH",
        "de": "APP-TITLE-GERMAN",
        "fr": "APP-TITLE-FRENCH"
      },
      "section": "",
      "main": "kaskadi-dashboard.js",
      "description": {
        "en": "APP-DESCRIPTION-ENGLISH",
        "de": "APP-DESCRIPTION-GERMAN",
        "fr": "APP-DESCRIPTION-FRENCH"
      },
      "routes": [
        {
          "path": "/",
          "appPath": "/modules/@kaskadi/kaskadi-apps/kaskadi-dashboard/kaskadi-dashboard.js"
        }
      ]
    }
  ]

API resources

The following lambda functions are used in this API:

The following layers are used in this API:

get-apps

Name Sources Timeout Handler Layers
get-apps
  • HTTP (GET)
default handler

See configuration file for more details.

apps-api-layer

Description

Layer for apps-api

Dependencies

See configuration file for more details.

Stack tags

You can use any tags (and their respective values) visible below to find ressources related to this stack on AWS. See here for more details.

Tag Value
app kaskadi
service apps-api
logical-unit apps
type http

About

API to manage apps for a given project (only Kaskadi for now)

Topics

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •