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

Update Swagger Interface README #353

Merged
merged 2 commits into from
Apr 4, 2022
Merged

Update Swagger Interface README #353

merged 2 commits into from
Apr 4, 2022

Conversation

MRichards99
Copy link
Collaborator

Description

This PR just updates the README in a couple of areas that are a bit out of date. Mainly the Swagger Interface section, because we now have one for the search API. I've also added a link to the issue about updating the DataGateway API Swagger interface for the Python ICAT backend.

I've also prefixed the flask run commands with poetry run as that's something I've realised is outdated.

No version bump as this is just updating documentation.

  • Review code
  • Check GitHub Actions build
  • If icatdb Generator Script Consistency Test CI job fails, is this because of a deliberate change made to the script to change generated data (which isn't actually a problem) or is here an underlying issue with the changes made?
  • Review changes to test coverage

@MRichards99 MRichards99 requested a review from VKTB March 29, 2022 13:07
@codecov
Copy link

codecov bot commented Mar 29, 2022

Codecov Report

Merging #353 (e63adf8) into master (c6aa15e) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #353   +/-   ##
=======================================
  Coverage   94.46%   94.46%           
=======================================
  Files          39       39           
  Lines        3110     3110           
  Branches      311      311           
=======================================
  Hits         2938     2938           
  Misses        144      144           
  Partials       28       28           

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 c6aa15e...e63adf8. Read the comment docs.

@MRichards99 MRichards99 merged commit 29eabfd into master Apr 4, 2022
@MRichards99 MRichards99 deleted the swagger-readme branch April 4, 2022 10:31
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.

2 participants