question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Documentation about the web API is missing.

See original GitHub issue

A couple things I noticed trying to get started with the web API:

  • There are no usage instruction for the web client in the readme, just for the rtm client
  • It was unclear to me from the readme that I could use just the web client part of it to interact with our web API, so I went with another REST client library. Later I discovered this package fit my uses exactly when Don told me it definitely should (and then I found the example folder).
  • It looks like you need to instantiate the web client with a token, but you may not necessarily have a token and might be trying to get one using the oauth flow (and specifically the oauth.access method). I think it might make the most sense to instantiate a client without a token, and then it adds the token to itself automatically as part of calling oauth.access. Then, so I can reuse it for different calls for different users if I wanted to it could have methods (or properties?) to swap out the token on the client object I already have.

Issue Analytics

  • State:closed
  • Created 7 years ago
  • Comments:6 (2 by maintainers)

github_iconTop GitHub Comments

3reactions
ekmartincommented, May 16, 2016

You can actually use the web client without a token, so you could actually do something like this right now:

const client = new WebClient();
return client.oauth.access(clientId, clientSecret, code)
  .then(data => {
    const authClient = new WebClient(data.access_token);
  });

But I agree that it’s unclear.

0reactions
tylucaskelleycommented, May 31, 2016

Glad to hear it! And yeah, for now just reading the web api docs is good enough for what I’m doing but looking forward to seeing some real docs / examples from you guys!

Read more comments on GitHub >

github_iconTop Results From Across the Web

What's Missing From Your API Documentation - Stoplight Blog
The first documentation an API gets is usually a reference. It's foundational to the rest of your documentation. It provides the black-and-white ...
Read more >
Missing swagger REST descriptions for Web Api
Enable XML documentation for your subproject (from project properties / build) like you have for your Web API project.
Read more >
Missing documentation for web API operations? | GRANDNODE
There seems to be some missing documentation for the available web API operations? ... Are these documented somewhere else, or have i missed...
Read more >
doc for 'key' parameter missing - SonarQube - Sonar Community
[SonarQube 7.1] Small documentation bug in web API qualityprofiles/delete: doc for 'key' parameter missing · SonarQube · sonarqube, web_api.
Read more >
Documentation is missing figures · Issue #103 · OHDSI/WebAPI
I am trying to follow the instructions on how to setup PostgreSQL to deploy WebAPI ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found