Add OpenAPI API specification#527
Merged
andrii-i merged 6 commits intojupyter-server:mainfrom Jun 25, 2024
Merged
Conversation
andrii-i
added
enhancement
JasonWeill
approved these changes
Jun 25, 2024
andrii-i
added a commit
to andrii-i/jupyter-scheduler
that referenced
this pull request
Jun 26, 2024
* Add OpenAPI API specification
* run pre-commit
* fix SortField, CreateJob indentation
* add missing /job_definitions/{job_definition_id}/jobs endpoint
* remove unused 400 and 404 errors
* Add security section specifying query or Authorization header token auth
andrii-i
added a commit
to andrii-i/jupyter-scheduler
that referenced
this pull request
Jun 26, 2024
* Add OpenAPI API specification
* run pre-commit
* fix SortField, CreateJob indentation
* add missing /job_definitions/{job_definition_id}/jobs endpoint
* remove unused 400 and 404 errors
* Add security section specifying query or Authorization header token auth
andrii-i
added a commit
that referenced
this pull request
Jun 26, 2024
* Add OpenAPI API specification
* run pre-commit
* fix SortField, CreateJob indentation
* add missing /job_definitions/{job_definition_id}/jobs endpoint
* remove unused 400 and 404 errors
* Add security section specifying query or Authorization header token auth
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds OpenAPI specification of the current Jupyter Scheduler (v2.7.1) API contract. Documentation addition, does not change extension logic.
This formalizes an API contract and allows users and automated tools use the specification as a reference. For example, here's a human-friendly API specification generated by Swagger.io based on the specification: https://app.swaggerhub.com/apis/andrii-i/jupyter-scheduler/2.7.1-oas3. Future PRs should add a CI step building and publishing this human-readable API specification as a part of documentation.