MAAS

/api/docs/ does not show correct documentation

Bug #2034940 reported by Jack Lloyd-Walters
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
MAAS
Triaged
Medium
Unassigned
MAAS 3.5.0
3.4
Triaged
Medium
Unassigned
MAAS 3.4.x

Bug Description

This is *meant* to display the OpenApi docs formatted as swagger, see https://maas.io/docs/api for an example of what it's meant to be.

Presumably the openapi.html is failing to import swagger correctly, but double check.

Tags: api
Revision history for this message
Jack Lloyd-Walters (lloydwaltersj) wrote :

running make doc (soon to be make openapi-doc) generates the correct documentation as expected for a developer container.

The equivalent commands & install location need to be added to the MAAS snap & deb instructiond

Revision history for this message
Anton Troyanov (troyanov) wrote :

There is another issue with the local doc:

1. Navigate to /MAAS/docs/
2. API reference -> API documentation
3. It will try to open /MAAS/docs/ui/api.html which doesn't exist, so 404 is returned

Anton Troyanov (troyanov)
Changed in maas:
milestone: none → 3.5.0
importance: Low → Medium
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.