openapi-common-lib

Important : To make maintenance easier, this package has been merged with openapi-suite ( Link to GitHub repository ). Consider this package deprecated and replaced by openapi-suite (classes have kept the same name)

This library contains common code for openapi-client-gen and openapi-server-gen.
It makes no sense to use it alone.

Installation

Clone/git pull the repo into any local directory

$ git clone git@github.com:lscalese/openapi-common-lib.git

Open the terminal in this directory and call the command to build and run InterSystems IRIS in container:

$ docker-compose up -d

To open IRIS Terminal do:

$ docker-compose exec iris iris session iris -U IRISAPP
IRISAPP>

To exit the terminal, do any of the following:

Enter HALT or H (not case-sensitive)

What else is inside the repository

.github folder

1. objectscript-quality.yml
   with every push to master or main branch the workflow launches the repo test on objectscript issues with Objectscript Quality tool, see the examples. This works if the repo is open-source only.

Both workflows are repo agnostic: so they work with any repository where they exist.

.vscode folder

Contains two files to setup vscode environment:

.vscode/settings.json

Settings file to let you immediately code in VSCode with VSCode ObjectScript plugin)

.vscode/launch.json

Config file if you want to debug with VSCode ObjectScript

src folder

Contains source files.
src/iris contains InterSystems IRIS Objectscript code

dev.md

Contains a set of useful commands that will help during the development

docker-compose.yml

A docker engine helper file to manage images building and rule ports mapping an the host to container folders(volumes) mapping

Dockerfile

The simplest dockerfile which starts IRIS and imports code from /src folder into it.
Use the related docker-compose.yml to easily setup additional parametes like port number and where you map keys and host folders.

iris.script

Contains objectscript commands that are feeded to iris during the image building

module.xml

IPM Module’s description of the code in the repository.
It describes what is loaded with the method, how it is being tested and what apps neeed to be created, what files need to be copied.

Read about all the files in this artilce