Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "src/raml1/wrapped-ast/wrapperHelper08"

Index

Variables

schemaContentChars

schemaContentChars: string[]

Functions

RAMLVersion

  • RAMLVersion(api: Api): string

absoluteUri

absoluteUriParameters

allProtocols

  • allProtocols(api: Api): string[]
  • $helperMethod Protocols used by the API. Returns the protocols property value if it is specified. Otherwise, returns protocol, specified in the base URI. $meta{"deprecated":true}

    Parameters

    Returns string[]

allResourceTypes

allResources

allSecuredBy

allTraits

baseUriParameters

  • $helperMethod Retrieve an ordered list of all base uri parameters regardless of whether they are described in baseUriParameters or not Consider a fragment of RAML specification:

    version: v1
    baseUri: https://{organization}.example.com/{version}/{service}
    baseUriParameters:
      service:
    

    Here version and organization are base uri parameters which are not described in the baseUriParameters node, Thus, they are not among Api.baseUriParameters(), but they are among Api.allBaseUriParameters(). $meta={"name":"allBaseUriParameters","deprecated":true}

    Parameters

    Returns Parameter[]

baseUriParametersPrimary

  • $helperMethod Retrieve an ordered list of all base uri parameters regardless of whether they are described in baseUriParameters or not Consider a fragment of RAML specification:

    version: v1
    baseUri: https://{organization}.example.com/{version}/{service}
    baseUriParameters:
      service:
    

    Here version and organization are base uri parameters which are not described in the baseUriParameters node, but they are among Api.baseUriParameters(). $meta={"name":"baseUriParameters","override":true}

    Parameters

    Returns Parameter[]

childMethod

childResource

completeRelativeUri

  • completeRelativeUri(res: Resource): string

expandTraitsAndResourceTypes

  • expandTraitsAndResourceTypes(api: Api): Api

extractParams

findTemplates

getMethod

getResource

getTemplateParametrizedProperties

isApi

  • isApi(obj: any): boolean

isOkRange

  • isOkRange(response: Response): boolean

load

methodId

  • methodId(method: Method): string
  • $helperMethod For methods of Resources: {parent Resource relative path} {methodName}. For methods of ResourceTypes: {parent ResourceType name} {methodName}. For other methods throws Exception.

    Parameters

    Returns string

ownerApi

parent

parentResource

protocolsPrimary

  • protocolsPrimary(api: Api): string[]
  • //$helperMethod Protocols used by the API. Returns the protocols property value if it is specified. Otherwise, returns protocol, specified in the base URI. $meta__={"name":"protocols","override":true}

    Parameters

    Returns string[]

qName

referenceName

  • referenceName(reference: Reference): string

referencedObject

referencedResourceType

referencedTrait

relativeUriSegments

  • relativeUriSegments(res: Resource): string[]

resourceTypesPrimary

schemaContent

  • schemaContent(bodyDeclaration: BodyLike): string

securedByPrimary

securityScheme

securitySchemeName

structuredValue

traitsPrimary

uriParameters

  • $helperMethod Retrieve an ordered list of all uri parameters including those which are not described in the uriParameters node. Consider a fragment of RAML specification:

    /resource/{objectId}/{propertyId}:
      uriParameters:
        objectId:
    

    Here propertyId uri parameter is not described in the uriParameters node, Thus, it is not among Resource.uriParameters(), but it is among Resource.allUriParameters(). $meta={"name":"allUriParameters","deprecated":true}

    Parameters

    Returns Parameter[]

uriParametersPrimary

  • $helperMethod Retrieve an ordered list of all uri parameters including those which are not described in the uriParameters node. Consider a fragment of RAML specification:

    /resource/{objectId}/{propertyId}:
      uriParameters:
        objectId:
    

    Here propertyId uri parameter is not described in the uriParameters node, but it is among Resource.uriParameters(). $meta={"name":"uriParameters","override": true}

    Parameters

    Returns Parameter[]

Generated using TypeDoc