Skip to content

Commit a6782bd

Browse files
docs(troubleshoot): add Import Issues section
Expand troubleshooting guide with common import issues: - 'No service found' or empty import - Artifact validation errors - External references ($ref) not resolved Each issue includes things to check and pointers to existing documentation. Signed-off-by: Pratik Mahalle <mahallepratik683@gmail.com>
1 parent 3066aab commit a6782bd

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

  • content/documentation/guides/troubleshoot

content/documentation/guides/troubleshoot/_index.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,3 +71,43 @@ You just have to edit the `docker-compose.yml` file to uncomment/enable the corr
7171
> Depending on the type of deployment (with or without asynchronous features), these container definitions may be distributed on different files.
7272

7373
</details>
74+
75+
## Import Issues
76+
77+
Common problems when importing API artifacts into Microcks.
78+
79+
<details>
80+
<summary><strong>"No service found" or empty import</strong></summary>
81+
82+
Things to check:
83+
- **Artifact format**: Ensure your file follows the expected conventions for your API type. See [Artifacts Reference](/documentation/references/artifacts/) for format-specific rules.
84+
- **Examples defined**: Microcks relies on examples to create mocks. Verify you have defined examples in your OpenAPI, AsyncAPI, Postman collection, or other supported formats.
85+
- **YAML/JSON syntax**: Validate your artifact with a linter. Malformed files may silently fail to import.
86+
- **API version**: Make sure the `info.version` field is present and not empty.
87+
88+
</details>
89+
90+
<details>
91+
<summary><strong>Artifact validation errors</strong></summary>
92+
93+
Things to check:
94+
- **Schema compliance**: Validate your artifact against the appropriate specification (OpenAPI, AsyncAPI, etc.) using tools like [Swagger Editor](https://editor.swagger.io/) or [AsyncAPI Studio](https://studio.asyncapi.com/).
95+
- **File encoding**: Use UTF-8 encoding without BOM. Special characters may cause parsing failures.
96+
- **Required fields**: Check for missing required fields like `operationId` in OpenAPI or `message` examples in AsyncAPI.
97+
98+
Related documentation:
99+
- [OpenAPI conventions](/documentation/references/artifacts/openapi-conventions/)
100+
- [AsyncAPI conventions](/documentation/references/artifacts/asyncapi-conventions/)
101+
- [Postman conventions](/documentation/references/artifacts/postman-conventions/)
102+
103+
</details>
104+
105+
<details>
106+
<summary><strong>External references ($ref) not resolved</strong></summary>
107+
108+
Things to check:
109+
- **Import method**: Direct upload does not resolve external `$ref` by default. Use an Importer job instead, which can handle relative and remote references.
110+
- **Reference base URL**: When using Importers, configure the reference base URL if your references use relative paths. See [Importing Services & APIs](/documentation/guides/usage/importing-content/#configure-dependency-resolution).
111+
- **Multi-artifact strategy**: For complex setups, consider the multi-artifact approach. See [Multi-artifacts explanations](/documentation/explanations/multi-artifacts/).
112+
113+
</details>

0 commit comments

Comments
 (0)