Skip to content

kaskadi/kaskadi-entry-point-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://erp.klimapartner.net

The following endpoints are defined in this API:

/

Supported methods:

GET (target lambda → serve)

Description:

This endpoint returns the required HTML content to start the Kaskadi application.

Authorization:

No authorizer found for this method.

Query string parameters:

Key Default Description
host Kaskadi public CDN Hosting server for all apps/assets.

Request body:

No body found for this method.

Examples:

Example #1

Request:

GET https://erp.klimapartner.net/

Response:

Status code:
  200

Headers:
  Access-Control-Allow-Origin: *
  content-type: text/html

Body:
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Kaskadi app</title>
    <link rel="icon" type="image/png" href="https://cdn.klimapartner.net/imgs/icons/favicon.png">
    <script type="module" src="https://cdn.klimapartner.net/modules/@kaskadi/kaskadi-apps/kaskadi-app.js"></script>
    <style>
      html, body {
        margin: 0;
        padding: 0;
        font-family: sans-serif;
        font-size: 16px;
      }
    </style>
  </head>
  <body>
    <kaskadi-app appVersion="1.0.0"></kaskadi-app>
  </body>
Example #2

Request:

GET https://erp.klimapartner.net/?host=localhost:3000

Response:

Status code:
  200

Headers:
  Access-Control-Allow-Origin: *
  content-type: text/html

Body:
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Kaskadi app</title>
    <link rel="icon" type="image/png" href="https://cdn.klimapartner.net/imgs/icons/favicon.png">
    <script type="module" src="https://cdn.klimapartner.net/modules/@kaskadi/kaskadi-apps/kaskadi-app.js"></script>
    <style>
      html, body {
        margin: 0;
        padding: 0;
        font-family: sans-serif;
        font-size: 16px;
      }
    </style>
  </head>
  <body>
    <kaskadi-app appVersion="1.0.0"></kaskadi-app>
  </body>

/{proxy+}

Supported methods:

GET (target lambda → serve)

Description:

This endpoint returns the required HTML content to start the Kaskadi application.

Authorization:

No authorizer found for this method.

Query string parameters:

Key Default Description
host Kaskadi public CDN Hosting server for all apps/assets.

Request body:

No body found for this method.

Examples:

Example #1

Request:

GET https://erp.klimapartner.net/we_can_type_anything_here

Response:

Status code:
  200

Headers:
  Access-Control-Allow-Origin: *
  content-type: text/html

Body:
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Kaskadi app</title>
    <link rel="icon" type="image/png" href="https://cdn.klimapartner.net/imgs/icons/favicon.png">
    <script type="module" src="https://cdn.klimapartner.net/modules/@kaskadi/kaskadi-apps/kaskadi-app.js"></script>
    <style>
      html, body {
        margin: 0;
        padding: 0;
        font-family: sans-serif;
        font-size: 16px;
      }
    </style>
  </head>
  <body>
    <kaskadi-app appVersion="1.0.0"></kaskadi-app>
  </body>
Example #2

Request:

GET https://erp.klimapartner.net/we_really_can_type_anything_here?host=localhost:3000

Response:

Status code:
  200

Headers:
  Access-Control-Allow-Origin: *
  content-type: text/html

Body:
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Kaskadi app</title>
    <link rel="icon" type="image/png" href="https://cdn.klimapartner.net/imgs/icons/favicon.png">
    <script type="module" src="https://cdn.klimapartner.net/modules/@kaskadi/kaskadi-apps/kaskadi-app.js"></script>
    <style>
      html, body {
        margin: 0;
        padding: 0;
        font-family: sans-serif;
        font-size: 16px;
      }
    </style>
  </head>
  <body>
    <kaskadi-app appVersion="1.0.0"></kaskadi-app>
  </body>

API resources

The following lambda functions are used in this API:

The following layers are used in this API: no layer defined in the configuration file.

serve

Name Sources Timeout Handler
serve
  • HTTP (GET)
  • HTTP (GET)
default handler

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 kaskadi-entry-point-api
logical-unit entry-point
type http