API Documentation Updates (Migrate from drf-yasg -> drf-spectacular)

[huntabyte]

Proposed Changes

I would like to work on updating the API documentation, however, the current package used to generate and manage the swagger docs lacks functionality, doesn't support OpenAPI 3.0, and isn't being actively maintained.

drf-spectacular is being actively maintained and provides some of the missing functionality.

I'd like to work on making this happen.

Justification

This would improve the developer's experience when building applications that interact with NetBox.

[arthanson]

@huntabyte are you still available and wanting to work on this?

[huntabyte]

@arthanson Yes, for sure.

[arthanson]

@huntabyte That is great - thank you. Please go ahead and start working on this in a new branch. It will probably be tough to fit it into 3.4 release, probably would be 3.5 but we can see.

If possible, it probably makes sense to keep the current OpenAPI 2.0 drf-yasg in and have the drf-spectacular OpenAPI 3.0 in parallel, but I'm not sure if that is possible? If you need any help on it or questions, please let me know.

[arthanson]

@huntabyte any progress on this so far? I saw a couple other issues that OpenAPI 3 would be nice for.