Using the version parameter of the baseUri in descriptions or examples allowed?


#1

Hi,

Should a tool parse the version uri paramter when it is used in descriptions, example(s), etc… ?

For example i have the following root declaration:

title: Test API.
version: v1
protocols: [ HTTPS ]
baseUri: https://myapi.com/{version}

and later on these snippets:

properties:
-url:
–type: string
–required: false
–maxLength: 150
–description: The location of the person.
–example: https://myapi.com/{version}/persons/36
–xml:
—attribute: true

examples:
-single:
–url: https://myapi.com/{version}/persons/235
–firstName: John
–lastName: Kelder

Should/must a tool parse the {version} parameter found in the property example and examples to the given “v1” in the root of the document?

TIA !

Best regards,
Nico Schoemaker


#2

Hi. I don’t think that this is necessary.