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.

Move API response format documentation to Swagger

See original GitHub issue

Description

The format expected from API response is documented here. Such content can be included in the API documentation itself in the openapi.yml file, providing a unique source of information.

Action

You must make changes on the v2 branch of this repository and make a pull request on the remote v2 branch as well.

You can import the existing openapi file to Swagger Editor for a better developer experience.

Based on the Swagger documentation, move the content of the current response format documentation to the openapi file.

Populated them in the components part of the yml file.

Delete the API response format file

Issue Analytics

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

github_iconTop GitHub Comments

1reaction
hippo604commented, Dec 28, 2021

Hi, I created PR #842 in response to this issue. Thanks.

0reactions
geromegrignoncommented, Dec 30, 2021

Closed by #842

Read more comments on GitHub >

github_iconTop Results From Across the Web

API Documentation Made Easy with OpenAPI & Swagger
Swagger Inspector is an easy to use developer tool to quickly execute any API request, validate its responses and generate a corresponding OpenAPI...
Read more >
Swagger UI tutorial | Documenting APIs
Swagger UI provides a display framework that reads an OpenAPI specification document and generates an interactive documentation website.
Read more >
Customizing Swagger Responses for Better API Documentation
How to configure custom example responses for Swagger API Docs. ... For example, let's say your resource returns an address.
Read more >
ReadMe: OpenAPI and Swagger for API Documentation
When you write your OpenAPI or Swagger docs, you can choose from either of two formats: JSON or YAML. Both will use the...
Read more >
How to Document an Existing API Using Swagger I Shockoe
Because the API only returned JSON the similarity between formatting for the response and the swagger response documentation led me to ...
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