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

Updated Lib-ms documentation with HTTP queries #113

Conversation

lindot11
Copy link
Contributor

@lindot11 lindot11 commented Sep 23, 2023

Added HTTP API Calls documentation to the two docs.

  • docs/admin/servers/lib/LIB-MS.md

  • servers/lib/README.md

@lindot11 lindot11 changed the title Libms docs Lib-ms HTTP API Calls documentation Sep 23, 2023
@lindot11 lindot11 changed the title Lib-ms HTTP API Calls documentation Lib-ms HTTP queries documentation Sep 23, 2023
@lindot11 lindot11 changed the title Lib-ms HTTP queries documentation Updated Lib-ms documentation with HTTP queries Sep 23, 2023
Copy link
Contributor

@prasadtalasila prasadtalasila left a comment

Choose a reason for hiding this comment

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

There is also another query which needs to be formatted.

To be sure, have you added both the HTTP queries - one for each graphQL query?

Also you can copy the same query content into docs/user/.../LIB-MS.md. You do not need to install the whole application for this.

Content-Length: 388

{
"query": "query {\n listDirectory(path: \"user1\") {\n repository {\n tree {\n blobs {\n edges {\n node {\n name\n type\n }\n }\n }\n trees {\n edges {\n node {\n name\n type\n }\n }\n }\n }\n }\n }\n}"
Copy link
Contributor

Choose a reason for hiding this comment

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

@lindot11 please format this query using any online json prettifier.

@codeclimate
Copy link

codeclimate bot commented Sep 23, 2023

Code Climate has analyzed commit 8bdebe0 and detected 0 issues on this pull request.

View more on Code Climate.

@lindot11
Copy link
Contributor Author

Yes, I did http queries on both listing directory and read file, and now done with prettifying json.

The last one docs/user/.../LIB-MS.md already has the http queries documented, but with a warning sign?
https://github.com/INTO-CPS-Association/DTaaS/blob/feature/distributed-demo/docs/user/servers/lib/LIB-MS.md#the-graphql-queries

@codecov-commenter
Copy link

Codecov Report

Merging #113 (8bdebe0) into feature/distributed-demo (a95ad9c) will increase coverage by 5.53%.
Report is 2 commits behind head on feature/distributed-demo.
The diff coverage is n/a.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@                     Coverage Diff                      @@
##           feature/distributed-demo     #113      +/-   ##
============================================================
+ Coverage                     64.37%   69.91%   +5.53%     
============================================================
  Files                            38        7      -31     
  Lines                           494      113     -381     
  Branches                         28        4      -24     
============================================================
- Hits                            318       79     -239     
+ Misses                          160       31     -129     
+ Partials                         16        3      -13     

see 31 files with indirect coverage changes

Components Coverage Δ
Website ∅ <ø> (∅)
Lib Microservice 69.91% <ø> (ø)

@prasadtalasila prasadtalasila mentioned this pull request Sep 27, 2023
prasadtalasila added a commit that referenced this pull request Sep 27, 2023
  - Updated documentation for http queries in relevant READMEs
  - Cleans up warnings from docs

---------
Co-authored-by: Linda Nguyen <[email protected]>
@prasadtalasila
Copy link
Contributor

prasadtalasila commented Sep 27, 2023

@lindot11 Your changes have been merged via PR #115.
Thanks for your first contribution.

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.

3 participants