[Feature] Create a product space for Synapse in the monorepo

[tschaffter]

What projects is this feature for?

OpenChallenges

Description

The goal of this ticket is to create a space to explore/demonstrate the development of Synapse components with Sage Monorepo.

This ticket covers the creation of three projects:

• libs/synapse/api-description: The OpenAPI description of Synapse
• libs/synapse/api-client-python: API client for Python generated by OpenAPI generator
• apps/synapse/notebook: Jupyter notebook that shows how to use the API client

Monorepo development workflow recipe: Update API client

• Update the API description in libs/synapse/api-description
• Generate the API client for X (e.g. Python) with OpenAPI generator
  • nx openapi-generate synapse-api-client-python
• (Bonus) Generate the HTML documentation of the API description (project template: apps/openchallenges/api-docs).

Notes:

• For the sake of this ticket, the API description could include only 1-2 read endpoints.
  • The goal of this ticket is not to quickstart the development of a comprehensive API description for Synapse, so 1-2 endpoints are enough.
  • The Synapse team currently does not provide an official OpenAPI description for Synapse.
  • Review the OA description previously created by @thomasyu888 in https://github.com/Sage-Bionetworks/synapse-rest-openapi.
• Create the above projects from these project templates:
  • libs/openchallenges/api-description
  • libs/schematic/api-client-python
  • apps/schematic/notebook

Tasks:

• [ ] #1673

cc: @thomasyu888 @brucehoff

Anything else?

No response

Code of Conduct

• [X] I agree to follow this project's Code of Conduct

[thomasyu888]

Before doing more work on this, the platform team wrote a design doc around generating an openAPI spec: https://sagebionetworks.jira.com/wiki/spaces/PLFM/pages/2907963440/Generate+OpenAPI+Spec. There is already some work done: https://github.com/Sage-Bionetworks/Synapse-Repository-Services/tree/develop/lib/lib-openapi, but I'm not sure how far along it is.

It might be more fruitful to try and contribute to this work - I know they would like to continue having the source of truth be the source code.

[tschaffter]

A minimal product space exists for Synapse.