Skip to content

Unifying markup languages for api schemas#190

Merged
rosesyrett merged 4 commits intoDiamondLightSource:mainfrom
rosesyrett:unify_markup
May 17, 2023
Merged

Unifying markup languages for api schemas#190
rosesyrett merged 4 commits intoDiamondLightSource:mainfrom
rosesyrett:unify_markup

Conversation

@rosesyrett
Copy link
Copy Markdown
Contributor

renamed some docs files, added more detail about apis. Made openapi.py output yaml instead of json

resolves #181

Also aims to be more descriptive in the docs about the purposes of the different api schemas we have

@rosesyrett rosesyrett self-assigned this May 12, 2023
@codecov
Copy link
Copy Markdown

codecov Bot commented May 12, 2023

Codecov Report

Merging #190 (82f9ea7) into main (a0e0ccc) will not change coverage.
The diff coverage is 100.00%.

❗ Current head 82f9ea7 differs from pull request most recent head d1117bb. Consider uploading reports for the commit d1117bb to get more accurate results

@@           Coverage Diff           @@
##             main     #190   +/-   ##
=======================================
  Coverage   87.62%   87.62%           
=======================================
  Files          41       41           
  Lines        1091     1091           
=======================================
  Hits          956      956           
  Misses        135      135           
Impacted Files Coverage Δ
src/blueapi/service/openapi.py 100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Comment thread docs/user/reference/messaging-spec.rst Outdated
Comment thread docs/user/reference/openapi.yaml Outdated
Comment thread docs/user/reference/rest-spec.rst Outdated
@rosesyrett rosesyrett requested a review from keithralphs May 17, 2023 14:48
Copy link
Copy Markdown
Contributor

@keithralphs keithralphs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rosesyrett rosesyrett merged commit f9cc6ca into DiamondLightSource:main May 17, 2023
@rosesyrett rosesyrett deleted the unify_markup branch May 17, 2023 15:01
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.

Unify markup language for API reference

2 participants