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

Document HTTP queries for lib microservice #104

Closed
prasadtalasila opened this issue Sep 11, 2023 · 3 comments
Closed

Document HTTP queries for lib microservice #104

prasadtalasila opened this issue Sep 11, 2023 · 3 comments
Milestone

Comments

@prasadtalasila
Copy link
Contributor

prasadtalasila commented Sep 11, 2023

The lib microservice uses graphql API. The graphql querires can be sent as HTTP post queries over the same API connection.

There are two graphql queries for lib microservice. The equivalent HTTP queries need to be documented.

Use Postman for checking HTTP queries.

@prasadtalasila prasadtalasila added this to the Release 0.3.0 milestone Sep 11, 2023
@lindot11
Copy link
Contributor

I have documented the HTTP queries for these docs and made a pull request

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

Not sure if I can do the last one, because my computer doesn't have the capacity to install the DTaaS application and try the HTTP queries as user.

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

@lindot11
Copy link
Contributor

Regarding the json prettifying issue.

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

The query value is one graphql query string, since the value in json should be a single line.
Alternatively I thought of changing the request body like below so it's easier to identify where to change the path variable in the query.

{
   "query": "query ($path: String!) { listDirectory(path: $path) { repository { tree { blobs { edges { node { name type } } } trees { edges { node { name type } } } } } } }",
   "variables": {
      "path": "user1"
   }
}

@prasadtalasila
Copy link
Contributor Author

fixed in PR #113 and #115

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

No branches or pull requests

2 participants