You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Given the changes from #1, it may be possible to generate openapi files describing each method, including it's type and docs information. This should make creating/maintaining documentation much easier.
Draft notes:
JsonSchema
For structs X and Y, with X::y being Y, the X::y documentation shows up but the Y one doesn't.
For the mods a and b and structs a::X and b::X, their name X will collide and thus should be able to potentially be named a.X and b.X.
Functions from the same trait or from the same impl block could be grouped together by having the same tag. This aligns whit an improvement for grouping the methods together from each impl block in a single trait, instead of each method having it's own trait.
OpenAPI
The spec 3.0.x forbids the GET http request methods from having a json body.
Currently the PATCH is being used instead of the GET.
The spec 3.1 allows for that and is thus should be better, but there is less tooling and library support for it. So for now it's advisable to stick to the 3.0.x spec.
The files, assuming they will exist as artifacts and can be linked to, can be rendered by third-parties websites such as in this example.
The text was updated successfully, but these errors were encountered:
Given the changes from #1, it may be possible to generate openapi files describing each method, including it's type and docs information. This should make creating/maintaining documentation much easier.
Draft notes:
X
andY
, withX::y
beingY
, theX::y
documentation shows up but theY
one doesn't.a
andb
and structsa::X
andb::X
, their nameX
will collide and thus should be able to potentially be nameda.X
andb.X
.trait
or from the sameimpl
block could be grouped together by having the sametag
. This aligns whit an improvement for grouping the methods together from eachimpl
block in a singletrait
, instead of each method having it's owntrait
.3.0.x
forbids theGET
http request methods from having a json body.PATCH
is being used instead of theGET
.3.1
allows for that and is thus should be better, but there is less tooling and library support for it. So for now it's advisable to stick to the3.0.x
spec.The text was updated successfully, but these errors were encountered: