Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tags in OpenApi schema are missing #15116

Open
6 of 11 tasks
spaut33 opened this issue Apr 18, 2024 · 0 comments
Open
6 of 11 tasks

Tags in OpenApi schema are missing #15116

spaut33 opened this issue Apr 18, 2024 · 0 comments

Comments

@spaut33
Copy link

spaut33 commented Apr 18, 2024

Please confirm the following

  • I agree to follow this project's code of conduct.
  • I have checked the current issues for duplicates.
  • I understand that AWX is open source software provided for free and that I might not receive a timely response.
  • I am NOT reporting a (potential) security vulnerability. (These should be emailed to [email protected] instead.)

Bug Summary

In the auto-generated OpenAPI schema, there is only one tag api which causes the Swagger page (/api/swagger) to appear as a long list of API endpoints without any grouping.

In older versions of the controller, prior to 22.4.0, I believe, the OpenAPI schema was generated with specific tags for each endpoint. For example:

"/api/v2/credentials/{id}/": {
  "delete": {
    ...
    },
    "summary": " Delete a Credential",
    "tags": ["Credentials"]
  },
...
"/api/v2/inventories/{id}/copy/": {
      "get": {
        ...
        },
        "tags": ["Inventories"]
      },
      "post": {
       ...
      },
        "tags": ["Inventories"]
      }
    },

In the latest versions the tag is the same for all endpoints:

"/api/v2/credentials/{id}/": {
  "delete": {
    ...
    },
    "summary": "Make GET request to this resource to retrieve a single credential",
    "tags": [
      "api"
    ]
  },
...
"/api/v2/inventories/{id}/copy/": {
      "get": {
        ...
        },
        "summary": "No Description for get on /api/{version}/inventories/{id}/copy/",
        "tags": [
          "api"
        ]
      },
    ...

AWX version

24.2.0

Select the relevant components

  • UI
  • UI (tech preview)
  • API
  • Docs
  • Collection
  • CLI
  • Other

Installation method

docker development environment

Modifications

no

Ansible version

2.14.3

Operating system

Debian 12

Web browser

Chrome, Edge

Steps to reproduce

  1. Build an run dev containers as usual
  2. Generate schema with docker docker exec tools_awx_1 make genschema or open https://127.0.0.1:8043/api/swagger

Expected results

All endpoints grouped by tags (Authentication, Activity Streams, Ad Hoc Command Events and etc)

Actual results

All endpoints are grouped under the same tag api
image

Additional information

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant