Skip to content

Commit

Permalink
update template properties temp
Browse files Browse the repository at this point in the history
  • Loading branch information
Conor Flynn committed Jan 28, 2023
1 parent 2f59227 commit 101a189
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 0 deletions.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# === Required Properties ===
# These properties are required regardless of the request and should maintain a uniform syntax.

# Name of the call to be referenced in the engine
request.name= template

# Base url of the REST API call
url.base= http://localhost:8080

# This property details all required properties to be passed on runtime when called. Optional
# properties are not required to be specified here. Note that properties can be given a default
# value or can be forced to be specified. The list is in (<key>, <value>) pairs, with each property
# having both a key and value specified. Default values can be placed in the <value> property.
# Key's with no default property that are required on runtime can be filled as '.'. In this example
# <property1> has the default value <value1>, <property2> is required on runtime, and <property3>
# has the default value <value3>.
url.properties= property1,value1,\
property2,.,\
property3,value3

# This property details all headers to be passed on runtime when generating the request.
# Optional headers can be passed on runtime and are not required to be specified here. Note
# that headers can be given a default value or can be forced to be specified. The list is in
# (<key>, <value>) pairs, with each property having both a key and value specified. Default
# values can be placed in the <value> property. Key's with no default property that are required
# on runtime can be filled as '.'. In this example <header1> has the default value <value1>,
# and headers <header2> and <header3> are required on runtime.
url.headers= header1,value1,\
header2,.,\
header3,.

# This property determines if the call is recursive, meaning that all data points required
# cannot be obtained in a single request. There are several integrated recursive types
# which have specific properties and handlers. Please review documentation to get a full
# list of these tags. To default with no recursive call, set this property to <single>.
# This property we will set to <parameterized> for a clearer example.
url.recursion.type=parameterized

# This property sets all tags pertaining to the type of recursive call. Please refer to
# the documentation for the full list of all tags and specified recursive types. All tags
# are in (<key>, <value>) pairs, with each property having both a key and value specified.
# Should a tag not require an accompanying <value>, please set it to '.'. In this
# example we will set the tags for <parameterized> which are as follows:
# -rp: recursive parameter
# -l: limit on items from request
# -t: type of parameter (url or incremental)
# FINISH

0 comments on commit 101a189

Please sign in to comment.