Resident AiiDAlab app#

AiiDAlab registration#

In order to register an AiiDaLab app on the platform, you first need to have the app registered in the AiiDAlab registry. Please check the AiiDAlab App developer guide to learn how to create your AiiDAlab app and publish it so it can be installed from AiiDAlab’s MarketPlace deployment.

MarketPlace registration#

The registration process is the same as the one defined in Application registration, with “Resident” app selected.

You can adapt the following OpenAPI specification for your app:

Sample OpenAPI
---
openapi: 3.0.0

info:
  title: dummy AiiDAlab App
  description: A dummy AiiDAlab app registered on the MarketPlace
  version: 0.1.0
  x-products:
    - name: AiiDAlab dummy app
servers:
  - url: https://materials-marketplace.aiidalab.net

paths:
  /user-redirect/apps/apps/home/open_app.ipynb?app=<dummy>&redirect=user-redirect/apps/apps/<dummy>/<nb>.ipynb:
    get:
      description: dummy App
      operationId: frontend
      security:
        - bearerAuth: []
      responses:
        "200":
          description: Success
        "404":
          description: Page not found

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

For the host app, select the previously registered AiiDAlab platform application.

AiiDAlab resident App registration