You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@couchdb.apache.org by GitBox <gi...@apache.org> on 2022/10/17 09:48:26 UTC
[GitHub] [couchdb] RafaelFigueiredo opened a new issue, #4213: Swagger UI or Postman Collection
RafaelFigueiredo opened a new issue, #4213:
URL: https://github.com/apache/couchdb/issues/4213
<!--- Provide a general summary of the issue in the Title above -->
## Expected Behavior
<!--- If you're describing a bug, tell us what should happen -->
<!--- If you're suggesting a change/improvement, tell us how it should work -->
I think would be useful if we have a postman collection to interact with the CouchDB database, avoid a lot of copying and pasting from documentation and also support code generation.
## Current Behavior
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
## Possible Solution
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
<!--- or ideas how to implement the addition or change -->
I am creating one for my projects if the community agree that is useful I am volunteer to maintain
## Steps to Reproduce (for bugs)
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1.
2.
3.
4.
## Context
<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
## Your Environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
* Version used:
* Browser Name and version:
* Operating System and version (desktop or mobile):
* Link to your project:
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Swagger UI or Postman Collection [couchdb]
Posted by "trajche (via GitHub)" <gi...@apache.org>.
trajche commented on issue #4213:
URL: https://github.com/apache/couchdb/issues/4213#issuecomment-2002421740
We wrote a script that scrapes docs and converts it to OpenAPI 3.x:
https://github.com/digitalnodecom/couchdb-swagger
You have the [couchdb.json ](https://github.com/digitalnodecom/couchdb-swagger/blob/master/couchdb.json) file if you don't want to run the script yourself.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Swagger UI or Postman Collection [couchdb]
Posted by "dragos-constantin-stoica (via GitHub)" <gi...@apache.org>.
dragos-constantin-stoica commented on issue #4213:
URL: https://github.com/apache/couchdb/issues/4213#issuecomment-1832380272
@RafaelFigueiredo can you post the link to the project where you have the swagger for CouchDB API? I am trying to do the same thing: swagger documentation for CouchDB API and I am more then happy to contribute if you have something ongoing. Otherwise, I will start a new project to document:
- swagger CouchDB API
- JSON schema for JSON objects (requests and responses)
There is a Postman collection here: https://www.postman.com/galactic-comet-36406/workspace/couchdb/collection/15985155-f511300e-848e-4ab2-a0a2-da13cb2e1065
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Swagger UI or Postman Collection [couchdb]
Posted by "RafaelFigueiredo (via GitHub)" <gi...@apache.org>.
RafaelFigueiredo commented on issue #4213:
URL: https://github.com/apache/couchdb/issues/4213#issuecomment-2018666638
> There is a Postman collection here: https://www.postman.com/galactic-comet-36406/workspace/couchdb/collection/15985155-f511300e-848e-4ab2-a0a2-da13cb2e1065
@dragos-constantin-stoica, this collection is the one I created.
@trajche nice working on the generator.
I was thinking of something like this https://hexdocs.pm/open_api_spex/3.4.0/readme.html, but I don't see direct support for Erlang.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org