Repository navigation
Describe every operation, response and filter parameter in OpenAPI; align comments and docs with the source (0.15.2) - #84
Merged
Conversation
…lign comments and docs with the source (0.15.2) - Mixin operations get descriptions and success response descriptions; bulk bodies are described. - PUT and PATCH /bulk declare their 404. - Error responses are per action: list shape and cursor codes on the list endpoint, event codes on subscribe and poll; middleware-dependent codes name their middleware. - Middleware.openapi_parameters: Idempotency documents its Idempotency-Key header. - make_filter_model describes every query parameter by field and operator. - Parametrised page models carry a description; LookupItem.pk/group state their JSON types. - Comments, docstrings and docs corrected where they contradicted the source. - Identifiers use US spelling; README and demo run through uv.
…ass page descriptions The cursor codes are kept only on a viewset serving the cursor shape, the Idempotency-Key header is not added to /schema, and settings docstrings state when each value is read.
✅ Incremental coverage — 100%
33 files not graded (14 ignored by pattern, 19 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.
Fixes from the compliance review of the changes since #54.
OpenAPI:
PUTandPATCH {base}/bulkdeclare their 404.event_topic_invalidonsubscribe,event_cursors_exceededonpoll. Middleware and collection codes name what answers them.Middleware.openapi_parameters: parameter objects a middleware reads, added byroute_viewsetto every operation but/schema.Idempotencydeclares itsIdempotency-Keyheader.make_filter_modeldescribes every query parameter by field and operator.PaginatedList[T],CursorPage[T]andListOf[T]carry a description; a documented subclass keeps its own.LookupItem.pkandgroupstate their JSON types.nullor absent instead ofNone.Comments and documentation:
count_recordsnoqa,watch()onChange), docstrings naming their callers, missing docstrings on public symbols (Python and TS).watch()example,list_itemsreturn type,materialize/take_pageas coroutines,Cookie.valuedefault,ListAction.Version 0.15.2 (patch) for both packages.