search

nambrot / rspec-api-blueprint-formatter

Auto-generate API docs from your RSpec tests!
MIT License
55 stars 10 forks source link

Sourcecode #5

Closed jozefvaclavik closed 3 years ago

jozefvaclavik commented 7 years ago

So the specs code doesn't really have place in ApiBlueprints. I think its fine to have it, but not inside of a Request -> Body. Its breaking then formatting of a Request. Maybe it could 1) optional and if included then 2) moved into Request -> Schema. I could do the PR as this is fairly small change.

@nambrot what do you think?

nambrot commented 7 years ago

Making this optional totally sounds like a great idea!

Fwiw, the reason we embed the code is to indicate some of the semantics of the behavior of the endpoints that is not clear from the request/response/comments. That being said, I understand that it is not a standard thing