Can't load external exemples (relative paths)

[oliviernguyenquoc]

I have examples in my 3.1 OpenAPI specifications like that:

components:
  examples:
    firstExample:
      summary: A sample example
      externalValue: "./fixtures/output/examples.json#/0"

When I import my yaml file, I got an error:

Error loading external example: 
http://localhost:8080/api/resources/fixtures/output/examples.json#/0

Please note that I'm using "Direct upload artifact" feature and when I try to use "Is a Secondary Artifact ? Just merge examples into existing API | Service definition. " select box, I have a success message but nothing appear in "APIs & Services" section

Any idea ? Any process to load these external files ?

[lbroudoux]

Hello @oliviernguyenquoc,

As of today, we do not follow refs provided by externalValue but just the one provided by $ref. So something like:

components:
  examples:
    firstExample:
      $ref: './fixtures/output/examples.json'

may work (not sure we're handling the subsequent path correctly though).

This could be a nice enhancement to bring to the OpenAPI importer.

[oliviernguyenquoc]

It's not working. Giving me a null as a response.
I think Microcks is not handeling local path.
Am I wrong ?

Should I create a new conversation with a tag "Idea" ?

[lbroudoux]

Hi,

I forgot to mention earlier (maybe obvious) that reference resolution only works if you're importing your OpenAPI file from Http repository such as a Git one. Direct upload doesn't allow you to get external references as we have no access to a baseline (in that case, your hard drive).

Will have an in-depth look at it and will try some stuffs and let you know.

[lbroudoux]

Hi @oliviernguyenquoc,

I've done some additional tests, and you're right: this is not supported as of today. Reference resolution is only done for external file fetching during validation but not for example value extraction. I think supporting externalValue with JSON Path/Pointer in your initial example is the way to go.

It would be awesome if you created a new issue in microcks/microcks asking for an enhancement/feature request. A comprehensive sample to illustrate the way you'd like/plan to use this feature is also more than welcome!

Thanks,

[oliviernguyenquoc]

Issue opened: #921