How to add description to URI parameter (not baseUri)?


#1

When I use API designer . I can’t add description to uri paramater which not in baseURI.
My uri is /theme/ids/{themeid}
I’ve try these 2 ways:

A

/theme/ids:
  description: get a theme
  /{themeid}:
    description: the theme id you assign

the review area shows:

Description

get a theme


URI Parameters

themeid required, string

B

/theme/ids/{themeid}:
  get:    
    description: get a theme
    queryParameters:
      themeid:
        description: the theme id you assign

review ares shows

Description

get a theme


URI Parameters

themeid required, string


Query Parameters

themeid string

the theme id you assign

None of them is the result I want. I just want to add descrption to URI parameter in normal path not baseUri.

Could anybody know to make it?


#2

I found the way to write

/theme/ids/{themeid}:
  uriParameters: 
    themeid: 
      description: the theme id you assign

#3

Just to extend your answer with another example where you can put description for both your resource url and uri param: -

/theme/ids/{yourParam}:
  description: This of resource
  uriParameters: 
    themeid: 
      description: This is a description of uri param
      required: false
  get:
    description: Get Service.

#4

you can add it to each URI when you add it… just use one tab and write description.
/myuri/ids/{someParam}:
description: This of resource description
get:
description: Method descriptin