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.

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

More opinionated schema documentation #117

Merged
merged 49 commits into from
Jul 9, 2020
Merged

More opinionated schema documentation #117

merged 49 commits into from
Jul 9, 2020

Conversation

jtc42
Copy link
Member

@jtc42 jtc42 commented Jul 7, 2020

Removing some more automatic documentation generation that was needlessly cluttering the code.

We’re gradually trying to ween off of OpenAPI, and replace it with a GUI for Thing Descriptions. With this in mind, I’m reducing our OpenAPI docs to focus on interaction affordances.

If people want to add documentation to generic views this can be done by accessing the LabThing apispec object.

@codecov
Copy link

codecov bot commented Jul 8, 2020

Codecov Report

Merging #117 into master will decrease coverage by 0.63%.
The diff coverage is 86.95%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #117      +/-   ##
==========================================
- Coverage   93.39%   92.76%   -0.64%     
==========================================
  Files          44       46       +2     
  Lines        1848     1865      +17     
  Branches      310      306       -4     
==========================================
+ Hits         1726     1730       +4     
- Misses         71       88      +17     
+ Partials       51       47       -4     
Flag Coverage Δ
#unittests 92.76% <86.95%> (-0.64%) ⬇️
Impacted Files Coverage Δ
src/labthings/tasks/pool.py 82.00% <ø> (-6.71%) ⬇️
src/labthings/tasks/thread.py 98.93% <ø> (-0.02%) ⬇️
src/labthings/default_views/root.py 80.00% <50.00%> (ø)
src/labthings/view/__init__.py 83.91% <75.67%> (-9.37%) ⬇️
src/labthings/deque.py 83.33% <83.33%> (ø)
src/labthings/labthing.py 97.01% <90.90%> (-1.43%) ⬇️
src/labthings/apispec/apispec.py 100.00% <100.00%> (+7.14%) ⬆️
src/labthings/apispec/converter.py 58.33% <100.00%> (-16.67%) ⬇️
src/labthings/default_views/actions.py 100.00% <100.00%> (ø)
src/labthings/default_views/docs/__init__.py 100.00% <100.00%> (ø)
... and 21 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 80410f1...2f1b117. Read the comment docs.

@jtc42
Copy link
Member Author

jtc42 commented Jul 9, 2020

Wow this turned out to be a massive MR. Lots of reorganisation, but the code and API is much simpler now, and much more sensible at the expense of being more opinionated.

@jtc42 jtc42 marked this pull request as ready for review July 9, 2020 14:56
@jtc42 jtc42 merged commit a5d30cf into master Jul 9, 2020
@jtc42 jtc42 deleted the overridable-schemas branch September 9, 2020 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant