Repository navigation
Describe library-owned parameters, models and the /schema response in OpenAPI (0.15.1) - #83
Merged
Merged
Conversation
… OpenAPI (0.15.1)
✅ Incremental coverage — 98.4%
12 files not graded (3 ignored by pattern, 9 not source files)
Coverage reports: coverage.json (coverage.py, 69 files) · coverage/clover.xml (clover, 13 files) — incremental-coverage-check v3.0.0 |
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
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.
Closes #82.
pkis described by theField(description=...)of the model's primary key field, elsePrimary key of the record.; an endpoint's ownPath(description=...)is kept.offset,cursorandlimithave descriptions;limitstates the viewset'sdefault_page_sizeandmax_page_size.@endpoint_docskeyparameters: descriptions by schema name, merged per parameter along the MRO; an unknown name raisesValueError.fltrparameter (it wastype: null). With a filter model, its fields were already published one per parameter with their descriptions.GET {base}/schemaanswers the named schemaOpenAPIDocumentand describes itself; overridable under the action nameschema.PaginatedList,CursorPage,LookupItem,LookupFilter,SortStateColumn,Change,RecordsChangedand the events viewset models.openapi_descriptions_test.pychecks that every parameter and every schema field of a full viewset plus the events endpoints has a description.Patch bump to 0.15.1 (Python and npm).