starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Swagger API has incorrect documentation for /api/circuits/provider-accounts/ and api/circuits/provider-networks #9919

New Issue
Closed
opened 2025-12-29 21:24:24 +01:00 by adam · 7 comments
adam commented 2025-12-29 21:24:24 +01:00
Owner
Copy Link

Originally created by @aaroneg on GitHub (Jun 29, 2024).

Deployment Type

Self-hosted

NetBox Version

v4.0.6

Python Version

3.10

Steps to Reproduce

View the swagger API docs located at https://$hostname/api/schema/swagger-ui/#/circuits/circuits_provider_accounts_create and you will see that the schema for ProviderAccountRequest does not mention any need to specify which provider the account is mapped to, but this field is in fact required.

Expected Behavior

The documentation should show all fields, especially required fields.

Observed Behavior

The required field 'provider' is missing from the documentation.

Originally created by @aaroneg on GitHub (Jun 29, 2024). ### Deployment Type Self-hosted ### NetBox Version v4.0.6 ### Python Version 3.10 ### Steps to Reproduce View the swagger API docs located at https://$hostname/api/schema/swagger-ui/#/circuits/circuits_provider_accounts_create and you will see that the schema for `ProviderAccountRequest` does not mention any need to specify which provider the account is mapped to, but this field is in fact required. ### Expected Behavior The documentation should show all fields, especially required fields. ### Observed Behavior The required field 'provider' is missing from the documentation.
adam added the type: bugstatus: duplicatetopic: OpenAPI labels 2025-12-29 21:24:24 +01:00
adam closed this issue 2025-12-29 21:24:24 +01:00
adam commented 2025-12-29 21:24:25 +01:00
Author
Owner
Copy Link

@aaroneg commented on GitHub (Jun 29, 2024):

Looks like it also affects /api/circuits/provider-networks/

@aaroneg commented on GitHub (Jun 29, 2024): Looks like it also affects `/api/circuits/provider-networks/`
adam commented 2025-12-29 21:24:25 +01:00
Author
Owner
Copy Link

@jeffgdotorg commented on GitHub (Jul 1, 2024):

Thank you for reporting this problem in NetBox. I was able to reproduce it in a fresh installation of v4.0.6. I'm moving your issue along to needs owner status.

We're generally aware that there are gaps in our OpenAPI coverage, but currently lack the team capacity to prioritize an effort to address these kinds of problems. If you or another developer with the requisite skills and capacity would like to work it through to a PR, please say so and a maintainer will assign the issue to you.

@jeffgdotorg commented on GitHub (Jul 1, 2024): Thank you for reporting this problem in NetBox. I was able to reproduce it in a fresh installation of v4.0.6. I'm moving your issue along to `needs owner` status. We're generally aware that there are gaps in our OpenAPI coverage, but currently lack the team capacity to prioritize an effort to address these kinds of problems. If you or another developer with the requisite skills and capacity would like to work it through to a PR, please say so and a maintainer will assign the issue to you.
adam commented 2025-12-29 21:24:25 +01:00
Author
Owner
Copy Link

@aaroneg commented on GitHub (Jul 1, 2024):

I'm not much of a python programmer but if you can whip up a short
explainer and it's simple enough i'm willing to give it a shot.

On Mon, Jul 1, 2024 at 3:42 PM Jeff Gehlbach @.***>
wrote:

Thank you for reporting this problem in NetBox. I was able to reproduce it
in a fresh installation of v4.0.6. I'm moving your issue along to needs
owner status.

We're generally aware that there are gaps in our OpenAPI coverage, but
currently lack the team capacity to prioritize an effort to address these
kinds of problems. If you or another developer with the requisite skills
and capacity would like to work it through to a PR, please say so and a
maintainer will assign the issue to you.

—
Reply to this email directly, view it on GitHub
https://github.com/netbox-community/netbox/issues/16765#issuecomment-2200983510,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AAKU7P7NO2UO7WNK5OMI54DZKG5LBAVCNFSM6AAAAABKDOPYWWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMBQHE4DGNJRGA
.
You are receiving this because you authored the thread.Message ID:
@.***>

@aaroneg commented on GitHub (Jul 1, 2024): I'm not much of a python programmer but if you can whip up a short explainer and it's simple enough i'm willing to give it a shot. On Mon, Jul 1, 2024 at 3:42 PM Jeff Gehlbach ***@***.***> wrote: > Thank you for reporting this problem in NetBox. I was able to reproduce it > in a fresh installation of v4.0.6. I'm moving your issue along to needs > owner status. > > We're generally aware that there are gaps in our OpenAPI coverage, but > currently lack the team capacity to prioritize an effort to address these > kinds of problems. If you or another developer with the requisite skills > and capacity would like to work it through to a PR, please say so and a > maintainer will assign the issue to you. > > — > Reply to this email directly, view it on GitHub > <https://github.com/netbox-community/netbox/issues/16765#issuecomment-2200983510>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AAKU7P7NO2UO7WNK5OMI54DZKG5LBAVCNFSM6AAAAABKDOPYWWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMBQHE4DGNJRGA> > . > You are receiving this because you authored the thread.Message ID: > ***@***.***> >
adam commented 2025-12-29 21:24:26 +01:00
Author
Owner
Copy Link

@jeffgdotorg commented on GitHub (Jul 1, 2024):

I'm not much of a python programmer but if you can whip up a short explainer and it's simple enough i'm willing to give it a shot.

I want your expectations to be realistic – I can't guarantee approval of a PR, but if you're up for a learning exercise, go for it. Addressing these gaps really needs to be done as part of a holistic effort, using a consistent approach that has yet to be fleshed out.

@jeffgdotorg commented on GitHub (Jul 1, 2024): > I'm not much of a python programmer but if you can whip up a short explainer and it's simple enough i'm willing to give it a shot. I want your expectations to be realistic – I can't guarantee approval of a PR, but if you're up for a learning exercise, go for it. Addressing these gaps really needs to be done as part of a holistic effort, using a consistent approach that has yet to be fleshed out.
adam commented 2025-12-29 21:24:26 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Jul 10, 2024):

This looks potentially like a display issue with spectacular, the field is required in the yaml:

    ProviderAccount:
      type: object
      description: Adds support for custom fields and tags.
      properties:
        id:
          type: integer
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        display:
          type: string
          readOnly: true
        provider:
          $ref: '#/components/schemas/Provider'
        name:
          type: string
          default: ''
          maxLength: 100
        account:
          type: string
          title: Account ID
          maxLength: 100
        description:
          type: string
          maxLength: 200
        comments:
          type: string
        tags:
          type: array
          items:
            $ref: '#/components/schemas/NestedTag'
        custom_fields:
          type: object
          additionalProperties: {}
        created:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        last_updated:
          type: string
          format: date-time
          readOnly: true
          nullable: true
      required:
      - account
      - created
      - display
      - id
      - last_updated
      - provider
      - url
@arthanson commented on GitHub (Jul 10, 2024): This looks potentially like a display issue with spectacular, the field is required in the yaml: ``` ProviderAccount: type: object description: Adds support for custom fields and tags. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true provider: $ref: '#/components/schemas/Provider' name: type: string default: '' maxLength: 100 account: type: string title: Account ID maxLength: 100 description: type: string maxLength: 200 comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - account - created - display - id - last_updated - provider - url ```
adam commented 2025-12-29 21:24:26 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Jul 10, 2024):

What's happening is the nested=True serializer is getting instantiated first in CircuitSerializer, it looks like Spectacular is caching the fields from this call and using that.

@arthanson commented on GitHub (Jul 10, 2024): What's happening is the nested=True serializer is getting instantiated first in CircuitSerializer, it looks like Spectacular is caching the fields from this call and using that.
adam commented 2025-12-29 21:24:26 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Jul 12, 2024):

closing as duplicate of #16670

@arthanson commented on GitHub (Jul 12, 2024): closing as duplicate of #16670
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: duplicate topic: OpenAPI type: bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#9919
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?