search

bihealth / sodar-server

SODAR: System for Omics Data Access and Retrieval
https://github.com/bihealth/sodar-server
MIT License
14 stars 3 forks source link

Update project for OpenAPI compatibility #1951

Closed mikkonie closed 2 months ago

mikkonie commented 5 months ago

Once upgrading to SODAR Core v1.0 in #1922, we should also ensure OpenAPI compatibility. Most likely there are some errors and warnings similar to what we encountered in e.g. bihealth/sodar-core#1440 and bihealth/sodar-core#1442. Also dependencies need to be updated, see bihealth/sodar-core#1444.

mikkonie commented 2 months ago

After fixing the get_serializer_context() implementations requiring a request object, the following warnings remain:

/home/mikkopen/.virtualenvs/sodar1.0/lib/python3.11/site-packages/rest_framework/schemas/openapi.py:48: UserWarning: You have a duplicated operationId in your OpenAPI schema: retrieveLandingZone
    Route: /landingzones/api/list/{project}, Method: get
    Route: /landingzones/api/retrieve/{landingzone}, Method: get
    An operationId has to be unique across your schema. Your schema may not work in other tools.
  warnings.warn(
/home/mikkopen/.virtualenvs/sodar1.0/lib/python3.11/site-packages/rest_framework/schemas/openapi.py:48: UserWarning: You have a duplicated operationId in your OpenAPI schema: retrieveIrodsAccessTicket
    Route: /samplesheets/api/irods/ticket/list/{project}, Method: get
    Route: /samplesheets/api/irods/ticket/retrieve/{irodsaccessticket}, Method: get
    An operationId has to be unique across your schema. Your schema may not work in other tools.
  warnings.warn(
/home/mikkopen/.virtualenvs/sodar1.0/lib/python3.11/site-packages/rest_framework/schemas/openapi.py:48: UserWarning: You have a duplicated operationId in your OpenAPI schema: retrieveIrodsDataRequest
    Route: /samplesheets/api/irods/request/retrieve/{irodsdatarequest}, Method: get
    Route: /samplesheets/api/irods/requests/{project}, Method: get
    An operationId has to be unique across your schema. Your schema may not work in other tools.
  warnings.warn(
/home/mikkopen/.virtualenvs/sodar1.0/lib/python3.11/site-packages/rest_framework/schemas/openapi.py:48: UserWarning: You have a duplicated operationId in your OpenAPI schema: retrieveSheetISAExport
    Route: /samplesheets/api/export/zip/{project}, Method: get
    Route: /samplesheets/api/export/json/{project}, Method: get
    An operationId has to be unique across your schema. Your schema may not work in other tools.
  warnings.warn(
/home/mikkopen/.virtualenvs/sodar1.0/lib/python3.11/site-packages/rest_framework/schemas/openapi.py:48: UserWarning: You have a duplicated operationId in your OpenAPI schema: createZoneSubmitMove
    Route: /landingzones/api/submit/validate/{landingzone}, Method: post
    Route: /landingzones/api/submit/move/{landingzone}, Method: post
    An operationId has to be unique across your schema. Your schema may not work in other tools.
  warnings.warn(
mikkonie commented 2 months ago

Done.