Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Please describe the POST methods to create the new DRS objects to the DRS database. #59

Open
polarbear127 opened this issue Feb 12, 2022 · 2 comments

Comments

@polarbear127
Copy link

Dear @jb-adams,

Thanks for providing this repo to help us to implement the DRS in our institute much easier.

However, a detailed description of POST methods is lacking. It would be great if the POST methods can be documented as well as GET methods.

Currently, I can only call the admin UI APIs to create a new object to DRS.

referenced issue: ga4gh/data-repository-service-schemas#383

Thanks,

@jb-adams
Copy link
Member

Thanks for raising this @polarbear127 , we really do need to get a swagger UI associated with the API.

We have the following endpoints for DRS object admin:

POST /admin/ga4gh/drs/v1/objects
PUT /admin/ga4gh/drs/v1/objects/{object_id}
DELETE /admin/ga4gh/drs/v1/objects/{object_id}

To hit these endpoints successfully, you will have to use the administrative API port, which is different from the public API port (defaults: public port: 4500, admin port: 4501)

But there are custom fields for storing information about the DRS Object that can't be inferred from the public API, so you'll need the Swagger UI to see how a DRS object is formatted when creating one in our implementation.

@polarbear127
Copy link
Author

Thanks for raising this @polarbear127 , we really do need to get a swagger UI associated with the API.

We have the following endpoints for DRS object admin:

POST /admin/ga4gh/drs/v1/objects
PUT /admin/ga4gh/drs/v1/objects/{object_id}
DELETE /admin/ga4gh/drs/v1/objects/{object_id}

To hit these endpoints successfully, you will have to use the administrative API port, which is different from the public API port (defaults: public port: 4500, admin port: 4501)

But there are custom fields for storing information about the DRS Object that can't be inferred from the public API, so you'll need the Swagger UI to see how a DRS object is formatted when creating one in our implementation.

Thanks a lot! I've gotten these APIs through developer tools in the web browser. But it's helpful that I can confirm they are correct!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants