search

Qiskit / qiskit-serverless

A programming model for leveraging quantum and classical resources
https://qiskit.github.io/qiskit-serverless/
Apache License 2.0
67 stars 27 forks source link

[EPIC] API documentation #1164

Open IceKhan13 opened 8 months ago

IceKhan13 commented 8 months ago

What is the expected behavior?

Implement API documentation for serverless (gateway)

User story

As developer I want to explore restful API specification of serverless (gateway) using swagger / openapi.

Issues in the epic

IceKhan13 commented 8 months ago

@akihikokuroda @psschwei @Tansito let's sketch high level API here

akihikokuroda commented 8 months ago

Is this just for REST APIs? The Qiskit IBM Runtime has the client docs in addition to the REST API docs. Screenshot 2024-01-29 at 1 00 59 PM

psschwei commented 8 months ago

I think the goal is to move ALL documentation over

IceKhan13 commented 8 months ago

first swagger for API docs and then we will move client docs separately, via markdown templates

akihikokuroda commented 8 months ago

Catalog API: https://github.com/Qiskit-Extensions/quantum-serverless/issues/1170#issuecomment-1917931921 RuntimeJob API: https://github.com/Qiskit-Extensions/quantum-serverless/pull/1197#issue-2105690655 + ModelView APIs