Update workflows docs for changes in floe v0.17.0 and document builtin method parameters #1861
Conversation
agrare
force-pushed
the
update_workflows_docs
branch
from
e002279 to
08ef05e
Compare
agrare
force-pushed
the
update_workflows_docs
branch
from
46be44e to
7fe2243
Compare
Fryguy
changed the title
agrare
force-pushed
the
update_workflows_docs
branch
2 times, most recently
from
2cb44f8 to
af078ac
Compare
agrare
changed the title
|
Okay @Fryguy updated the parameters for http, email, embedded_ansbile, and provision_execute. |
| * `floe://http` - Execute any HTTP action | ||
|
|
||
| Parameters: | ||
| * `Method` (required) - HTTP method name. Permitted values: `GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `PATCH`, `OPTIONS`, or `TRACE` |
There was a problem hiding this comment.
Not for now, but might be useful to default to GET
There was a problem hiding this comment.
Depends on ManageIQ/manageiq-providers-workflows#145
| * `MinVersion` - Integer - Minimum SSL Version. | ||
| * `MaxVersion` - Integer - Maximum SSL Version. | ||
| * `Ciphers` - String - Ciphers supported. |
There was a problem hiding this comment.
We should default these to sensible defaults and doc the defaults (unless they are coming from elsewhere and that is too difficult)
There was a problem hiding this comment.
Farady doesn't list the default if unset, it just points to https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ciphers-3D
| * `Encoding` - String | ||
| * `JSON` - JSON encodes the request and decodes the response |
There was a problem hiding this comment.
Is there a default value for when you don't pass it? Like, would it string String encoding? I know we don't literally set that under the covers, but I wonder if it should be a choice if the user wants to be more explicit.
There was a problem hiding this comment.
We only set json encoding if Encoding==JSON anything else passed has no effect.
| * `Encoding` - String | ||
| * `JSON` - JSON encodes the request and decodes the response | ||
| * `Proxy` | ||
| * `Uri` - String - URI of the proxy. |
There was a problem hiding this comment.
Should this be Url to mirror the other Url parameter?
There was a problem hiding this comment.
Faraday proxy options has uri specifically https://lostisland.github.io/faraday/#/customization/proxy-options and since that is technically more broad than a url I left it.
|
|
||
|  | ||
|
|
||
| ## Upgrading |
There was a problem hiding this comment.
My only thought is this should probably go into the blog post and not the docs. On downstream I could see it going into an Upgrade page. For now though I'm ok with merging this.
There was a problem hiding this comment.
Yeah we can drop it from here once we have release notes to add it to, didn't want to completely lose it until then.
agrare
force-pushed
the
update_workflows_docs
branch
3 times, most recently
from
a88e407 to
a272cb2
Compare
agrare
force-pushed
the
update_workflows_docs
branch
from
a272cb2 to
cf8a9e7
Compare
|
@jaychtw please also review. |
agrare
force-pushed
the
update_workflows_docs
branch
from
cf8a9e7 to
b70c9ac
Compare
agrare
force-pushed
the
update_workflows_docs
branch
from
b70c9ac to
72545ac
Compare
|
@jaychtw I'm going to merge for now to get this in. Any comments you have we can do in a follow-up PR. |
|
Backported to |
Update workflows docs for changes in floe v0.17.0 and document builtin method parameters (cherry picked from commit 258d815)
2 participants
This updates the embedded_workflows docs to call out changes to Credentials handling and nested hash interpolation in floe 0.17.0
Also documents the builtin runner methods in floe and manageiq (floe://http was added in 0.17.0, we were missing any documentation on the manageiq:// ones so added those as well)