Skip to content

API docs: swagger-ui docs missing resource endpoints #687

@dennisvang

Description

@dennisvang

On some deployments, the swagger-ui interface remains incomplete. Specifically, the resource endpoints are not included.

For example, running minimal compose file of v1.16 locally, I see the following:

Image

Whereas I would expect to see the following, which includes endpoints for catalog, dataset, etc.:

Image

UPDATE

How to reproduce:

  1. run compose/fdp/ephemeral/v1:
    export FDP_VERSION=1.18.1  # or older
    cd compose/fdp/ephemeral/v1
    docker compose up -d
  2. visit the api docs in the browser to observe missing endpoints, e.g. http://localhost/swagger-ui.html or http://localhost/v3/api-docs (look in paths or observe that fdpGenericPaths is an empty object {})
  3. restart the fdp:
    docker compose restart fdp
  4. visit the api docs again and observe the missing endpoints are now present

Also note that the restart consistently leads to another known issue, viz. #516, when using the ephemeral stack:

No metadata found for the uri 'http://localhost'

This does not happen with the persistent stack (compose/fdp/persistent/v1)

Metadata

Metadata

Assignees

Labels

bugSomething's wrongdocsRelated to documentationduplicateA similar issue already exists

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions