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.

API documentation doesn't display documentation for drafts parameters usefully

See original GitHub issue

Following #18074, we have API documentation for the new drafts synchronization endpoints. However, while the GET endpoint renders the detailed documentation about individual fields within a draft object, the other endpoints do not, e.g.:

image

Issue Analytics

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

github_iconTop GitHub Comments

1reaction
timabbottcommented, Nov 6, 2021

I don’t know this code super well; @orientor or @MSurfer20 is likely better positioned to help. I think adding a missing recursive call makes sense, but I haven’t looked at the code myself.

0reactions
EmmalineLakecommented, Nov 9, 2021

@orientor or @MSurfer20 See this CZO chat for further questions. The above question isn’t correct. Thanks!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Documenting REST API resources - GitLab Docs
Writing styles, markup, formatting, and other standards for the GitLab RESTful APIs.
Read more >
Set up a method request in API Gateway - AWS Documentation
Set up a method request in API Gateway · Adding an HTTP method to the method request · Configuring request parameters · Defining...
Read more >
Preview API - Contentful
The Preview API will include draft entries with the same caveat that unresolved links will not appear in the includes array.
Read more >
API Documentation Guide and Best Practices - Stoplight
In this API documentation guide, we'll cover the basics of how to document APIs and ... The best and most useful API references...
Read more >
API Documentation - Beamer
These are the developer docs for the Beamer API. ... Some parameter is missing or doesn't follow the API specification. 401 Unauthorized.
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