Papupata Documentation

API Reference

class DeclaredAPI

property apiUrlParameters

Availability

This functionality is available from papupata version 1.5.0 onwards.

Purpose

Exposes the path and query parameters of the api

Members

NameTypeData type/return typeDescriptionRequired
paramspropertyTypeMappingPath parameters of the APIfalse
querypropertyTypeMappingRegular query parameters of the APIfalse
optionalQuerypropertyTypeMappingOptional query parameters of the APIfalse
boolQuerypropertyTypeMappingBoolean query parameters of the APIfalse

To get a list of fields similar to papupata 1.x you can use Object.keys on the TypeMappings, though do note that boolQuery is only populated if it is used explicitly, boolean values specified in normal query will be in query instead.