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.

Sign up for GitHub

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

Jump to bottom

[EPIC] API documentation #1164

Open
IceKhan13 opened this issue Jan 17, 2024 · 5 comments
Open

[EPIC] API documentation #1164

IceKhan13 opened this issue Jan 17, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request epic For epics and projects good first issue Good for newcomers priority: high High priority project: gateway Label to identify features related with gateway project
Milestone
Q1'24

Comments

@IceKhan13
Copy link
Member

IceKhan13 commented Jan 17, 2024 •
edited
Loading

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 IceKhan13 added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers epic For epics and projects priority: high High priority project: gateway Label to identify features related with gateway project labels Jan 17, 2024
@IceKhan13 IceKhan13 added this to the Q1'24 milestone Jan 17, 2024
This was referenced Jan 17, 2024
Closed
Open
@psschwei psschwei mentioned this issue Jan 23, 2024
Merged
@IceKhan13
Copy link
Member Author

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

@akihikokuroda
Copy link
Collaborator

akihikokuroda commented Jan 29, 2024 •
edited
Loading

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
Copy link
Collaborator

I think the goal is to move ALL documentation over

@IceKhan13
Copy link
Member Author

IceKhan13 commented Jan 30, 2024 •
edited
Loading

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

@akihikokuroda
Copy link
Collaborator

akihikokuroda commented Jan 31, 2024 •
edited
Loading

Catalog API: #1170 (comment)
RuntimeJob API: #1197 (comment) + ModelView APIs

@Qiskit Qiskit deleted a comment from pandasa123 Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request epic For epics and projects good first issue Good for newcomers priority: high High priority project: gateway Label to identify features related with gateway project
Projects
None yet
Milestone
Q1'24
Development

No branches or pull requests
3 participants
@IceKhan13 @akihikokuroda @psschwei