Skip to content

duplicate spec outputs causing conflicts #1101

@katchenribaes

Description

@katchenribaes

Describe the problem

Context

I'm currently configuring this plugin in a documentation repository that is structured to generate internal and client documentation. It contains multiple spec outputs for internal and external (client) documentation too. The swagger specs are being auto-generated under /generated/ swagger-internal/ and /generated/swagger-external/ respectively (they don't exist statically in this doc repository). Some internal and external specs share the same APIs. For instance, /generated/swagger-internal/abc.json shares the exact same APIs as /generated/swagger-external/abc.json except for one API (only available internally), which is the reason for generating two different outputs.

What is happening

When I add the categoryLinkSource as tag in both internal and external configurations, the client build builds successfully but the internal build fails with:
Error: Docusaurus static site generation failed for 4 paths:
[INFO] [npm|docusaurus] - "/docs/client/abc/api/endpoints/api-1"
[INFO] [npm|docusaurus] - "/docs/client/abc/api/endpoints/api-2"
[INFO] [npm|docusaurus] - "/docs/client/abc/api/endpoints/api-3"
[INFO] [npm|docusaurus] - "/docs/client/abc/api/endpoints/api-4"

These are the paths to the categories of the APIs shared between /generated/swagger-internal/abc.json and /generated/swagger-external/abc.json.

I've tried using patches to change tags and operationId in one of the specs to avoid overlaps, but the issue persists. Does anyone have an idea what could be causing this? Even if I only add the categoryLinkSource to the client documentation, the internal documentation build fails.

Without this property, the documentation builds successfully for both outputs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions