OpenAPI spec for Jupyter Workflows #531
Conversation
nsingl00
force-pushed
the
workflow_openapi
branch
2 times, most recently
from
7d800f3
to
5d8fb4c
Compare
andrii-i
added
enhancement
nsingl00
force-pushed
the
workflow_openapi
branch
2 times, most recently
from
9ee87f8
to
0c60643
Compare
There was a problem hiding this comment.
Hi @nsingl00. Thank you for opening and rebasing this PR. Currently there are some .yaml formatting errors. I left suggestions on and comments about fixing them, could you please give them a look? Using IDE with .yaml linting should highlight all the errors mentioned.
Some OpenAPI tools that I find useful:
- VSCode OpenAPI plugin https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi
- https://editor.swagger.io/, it can generate a (more) human-readable API docs which should make API discussions and reviews in the future easier. Please see https://app.swaggerhub.com/apis/andrii-i/jupyter-scheduler/2.7.1-oas3 for an example.
nsingl00
force-pushed
the
workflow_openapi
branch
from
8717348
to
7af10dc
Compare
nsingl00
force-pushed
the
workflow_openapi
branch
from
70c342a
to
4082eb9
Compare
There was a problem hiding this comment.
Thank you for the update @nsingl00. Currently some models / components referenced in the spec are missing from the components section: CreateJobFromDefinition, RuntimeEnvironment, DSNamespace, JobFile. Could you please add these missing models / components to the spec?
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/CreateJobFromDefinition' |
There was a problem hiding this comment.
"Failed to resolve reference" error
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/CreateJobFromDefinition' |
There was a problem hiding this comment.
"Failed to resolve reference" error
| schema: | ||
| type: array | ||
| items: | ||
| $ref: '#/components/schemas/RuntimeEnvironment' |
There was a problem hiding this comment.
"Failed to resolve reference" error
| schema: | ||
| type: array | ||
| items: | ||
| $ref: '#/components/schemas/DSNamespace' |
There was a problem hiding this comment.
"Failed to resolve reference" error
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/DSNamespace' |
There was a problem hiding this comment.
"Failed to resolve reference" error
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/DSNamespace' |
There was a problem hiding this comment.
"Failed to resolve reference" error
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/DSNamespace' |
There was a problem hiding this comment.
"Failed to resolve reference" error
| job_files: | ||
| type: array | ||
| items: | ||
| $ref: '#/components/schemas/JobFile' |
There was a problem hiding this comment.
"Failed to resolve reference" error
No description provided.