This folder contains all the SCANOSS proto definitions for its gRPC services.
The API is made up of different services
These services have some shared items, which can be found in Common.
To create/update the JSON data structures in request, help can be found at json-to-proto.
For details on how to compile the supported language libraries, please look in LIBRARY_BUILD.md.
There are two support scripts in this folder:
The build.sh script provides the support for compiling the library code for the supported language types.
Examples for consuming this script can be found in the Makefile.
The copy_python.sh script provides the support for copying the generated Python library code from this repository into the scanoss.py project on the local file system. It defaults to assuming the scanoss.py repo is in the parent folder beside the papi repo.
Examples for consuming this script can be found in the Makefile.
In order to support the generation of GRPC Gateway (Open API) REST interfaces, the following protobuf folders have been copied into papi:
These definitions aid in the generation of the GRPC Gateway code and the Open API (swagger) spec files. More details on how this is used can be found here.