mdeuser commented on a change in pull request #3352: API GW doc update to
include path parameter example
URL:
https://github.com/apache/incubator-openwhisk/pull/3352#discussion_r170916148
##########
File path: docs/apigateway.md
##########
@@ -104,52 +103,61 @@ You have a series of actions to implement your backend
for the book club:
| putBooks | PUT | updates book details |
| deleteBooks | DELETE | deletes a book |
-Let's create an API for the book club, named `Book Club`, with `/club` as its
HTTP URL base path and `books` as its resource.
+Let's create an API for the book club, named `Book Club`, with `/club` as its
HTTP URL base path and `books` as its resource and `{isbn}` as a path parameter
used to identify a specific book by its ISBN.
+
+When using path parameters, the API must be defined with a response type of
`http`, and the path, including the actual path parameter value(s), will be
available in the `__ow_path` field of the action's JSON parameter.
Review comment:
yeah.. i was not sure how to document what's being passed. and yes, it is
*not* the full url path. i'll try to figure out a way to doc this better
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
