Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 1.61 KB

troubleshoot-implementation-errors.adoc

File metadata and controls

55 lines (38 loc) · 1.61 KB
Raw

Implementation Errors

reuse::partial$beta-banner.adoc

You might encounter problems when implementing an API.

Something Failed While Scaffolding an API

If you attempt to scaffold an API that references these types of fragments, you see a message like the following:

Something failed while scaffolding API

The scaffold fails and the flows and other elements aren’t created.

If you use the iterative approach to scaffold the API (using multi-root workspaces), the implementation project folder structure is not created.

To work around this issue, before scaffolding the API:

  1. Add the fragment directly to a folder in your API spec project, such as fragments:

    Fragment folder in the Explorer view

  2. Change the path to the fragment from Exchange to the local folder, for example:

    Reference Local OAS Fragment
    $ref: fragments/frag-defs.yaml#/components/examples/flightsList
    Reference OAS Fragment on Exchange
    $ref: exchange_modules/e91cab06-650b-4634-9c6f-5bc4f4fc4d17/frag-defs/1.0.0/frag-defs.yaml#/components/examples/flightsList

  3. Re-scaffold the API.