Openapi fix spec #30

TobiPeterG · 2024-08-26T13:42:00Z

This switches to openapi-codegenerator and tries to patch the spec file with the patcher from netbox. Doesn't solve all issues yet.

TobiPeterG · 2024-08-27T12:13:59Z

The code now successfully compiles. Please check if the changes to the spec file are appropriate.

glennmatthews · 2024-08-27T13:13:06Z

development/scripts/fix-spec.py

+        if 'failover_strategy' in schema.get('properties', {}):
+            prop = schema['properties']['failover_strategy']
+            if 'default' in prop and prop['default'] is None:
+                print(f"Removing 'default: null' in {name}.failover_strategy")
+                del prop['default']


For reference:

failover_strategy: type: object properties: value: type: string enum: - '' - active-active - active-passive label: type: string enum: - (unspecified) - Active/Active - Active/Passive default: null

Looks like the default should probably be the empty string, not null.

Also:

failover_strategy: default: null oneOf: - $ref: '#/components/schemas/FailoverStrategyEnum' - $ref: '#/components/schemas/BlankEnum'

Not immediately clear to me whether the issue is with both or either of these cases.

Per slack it's the latter case that's an issue. Probably both are wrong though.

Possibly relevant: OpenAPITools/openapi-generator#16775

Not clear yet where the null is coming from here as both the model and the serializer define blank=True and allow_blank=True but not null=True or allow_null=True here.

So this is an issue of the specification, right?
Should I create an issue on nautobot's project?

I think that would be appropriate, yes. Thanks!

Created an issue :)
nautobot/nautobot#6157

glennmatthews · 2024-08-27T13:14:01Z

development/scripts/fix-spec.py

+            # Replace nested `type` field in PowerFeed
+            if 'type' in schema['properties']:
+                type_property = schema['properties']['type']
+                if 'properties' in type_property and 'value' in type_property['properties']:
+                    value_property = type_property['properties']['value']
+                    if 'enum' in value_property and set(value_property['enum']) == {'primary', 'redundant'}:
+                        print(f"Replacing complex 'type' field in PowerFeed")
+                        schema['properties']['type'] = {
+                            'type': 'string',
+                            'enum': ['primary', 'redundant'],
+                            'default': 'primary'
+                        }


For reference:

type: type: object properties: value: type: string enum: - primary - redundant label: type: string enum: - Primary - Redundant default: value: primary label: Primary

This is an intended asymmetry in the API - on responses from the server, type should be a dict with keys value and label, but on requests to the server, the client should just specify a string corresponding to the value. The PowerFeed type should only be used on the response side, on the request side see WritablePowerFeedRequest, PatchedWritablePowerFeedRequest, BulkWritablePowerFeedRequest, PatchedBulkWritablePowerFeedRequest

Same comment on the other enum fields below.

Is this something we need to change here then and/or something that needs to be changed in the specification?
How should go-nautobot handle this?

Not sure yet. I currently believe that the generated schema is correct but there may be some nuance I'm missing.

glennmatthews · 2024-08-27T13:14:49Z

development/scripts/fix-spec.py

+            # Replace nested `supply` field in PowerFeed
+            if 'supply' in schema['properties']:
+                supply_property = schema['properties']['supply']
+                if 'properties' in supply_property and 'value' in supply_property['properties']:
+                    value_property = supply_property['properties']['value']
+                    if 'enum' in value_property and set(value_property['enum']) == {'ac', 'dc'}:
+                        print(f"Replacing complex 'supply' field in PowerFeed")
+                        schema['properties']['supply'] = {
+                            'type': 'string',
+                            'enum': ['ac', 'dc'],
+                            'default': 'ac'
+                        }


For reference:

supply: type: object properties: value: type: string enum: - ac - dc label: type: string enum: - AC - DC default: value: ac label: AC

glennmatthews · 2024-08-27T13:15:22Z

development/scripts/fix-spec.py

+            if 'phase' in schema['properties']:
+                phase_property = schema['properties']['phase']
+                if 'properties' in phase_property and 'value' in phase_property['properties']:
+                    value_property = phase_property['properties']['value']
+                    if 'enum' in value_property and set(value_property['enum']) == {'single-phase', 'three-phase'}:
+                        print(f"Replacing complex 'phase' field in PowerFeed")
+                        schema['properties']['phase'] = {
+                            'type': 'string',
+                            'enum': ['single-phase', 'three-phase'],
+                            'default': 'single-phase'
+                        }


For reference:

phase: type: object properties: value: type: string enum: - single-phase - three-phase label: type: string enum: - Single phase - Three-phase default: value: single-phase label: Single phase

glennmatthews · 2024-08-27T13:15:58Z

development/scripts/fix-spec.py

+            # Replace complex `type` object with a simpler string enum in Prefix
+            if 'type' in schema['properties']:
+                type_property = schema['properties']['type']
+                if 'properties' in type_property and 'value' in type_property['properties']:
+                    print(f"Replacing complex 'type' field in Prefix")
+                    schema['properties']['type'] = {
+                        'type': 'string',
+                        'enum': ['container', 'network', 'pool'],
+                        'default': 'network'
+                    }


For reference:

type: type: object properties: value: type: string enum: - container - network - pool label: type: string enum: - Container - Network - Pool default: value: network label: Network

development/scripts/fix-spec.py

.travis.yml

TobiPeterG · 2024-09-06T18:18:02Z

@chadell Is there something else that should be changed? :)

README.md

chadell · 2024-09-09T06:39:40Z

README.md


- [Network Automation with Go Book](https://github.com/PacktPublishing/Network-Automation-with-Go/blob/main/ch06/nautobot/main.go)


I think that having an example is great to get started, and adding the reference to this book it's good too even though is using an old version

I changed the reference to the terraform provider, as that will use the new go-nautobot code :)
Is that alright?

README.md

chadell · 2024-09-16T04:16:07Z

.README.md

+
+func main() {
+	token := "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+	check(err)


err is not defined at this point, please remove

chadell · 2024-09-16T04:16:58Z

.README.md

+	check(err)
+
+	config := nb.NewConfiguration()
+	config.Servers[0].URL = "localhost"


demo.nautobot.com ?

chadell

LGTM

chadell and others added 13 commits January 15, 2024 10:38

feat: ✨ Support Nautobot 2.x

41ee992

Use latest 1.x version

313b953

full test

ec4e7d9

update ci version

be2afc7

bump nautobot to 2.1.9

b3b71b7

switch to correct git module

790c2e0

fix dependencies

92f4a3b

Remove old commands

74afcfa

switch to openapi-generator�

e0db264

switch to swagger-codegen

1c70f6f

Nautobot bindings 2.16-beta

e341364

fix github workflow

f5f3d65

simplify code generation

2e9d3e5

TobiPeterG requested a review from chadell as a code owner August 26, 2024 13:42

Patch spec file

5eff772

TobiPeterG force-pushed the openapi-fix-spec branch from d19528b to 5eff772 Compare August 26, 2024 13:54

Fix spec patching, add missing "time" imports

92216ee

TobiPeterG force-pushed the openapi-fix-spec branch from 9945c72 to 92216ee Compare August 27, 2024 12:14

TobiPeterG added 4 commits August 27, 2024 14:34

Auto generate tests and update to nautobot 2.3.1

4091d92

Do not skip spec validation

a065233

Update github workflow to nautobot 2.3.1

4834308

Re-add LICENSE

438b5b9

This was referenced Aug 27, 2024

Update Support 2.x #27

Closed

Switch to openapi-generator #28

Closed

Switch to swagger generator #29

Closed

glennmatthews reviewed Aug 27, 2024

View reviewed changes

TobiPeterG mentioned this pull request Aug 28, 2024

Possible error in openAPI specification for failover_strategy property nautobot/nautobot#6157

Open

remove unused patches

82790ca

TobiPeterG force-pushed the openapi-fix-spec branch from 53e6ab4 to ac5af4d Compare August 29, 2024 20:42

TobiPeterG force-pushed the openapi-fix-spec branch from ac5af4d to cae84f3 Compare August 30, 2024 09:36

install docker-compose in ci

dcf52af

TobiPeterG force-pushed the openapi-fix-spec branch from cae84f3 to dcf52af Compare August 30, 2024 09:39

TobiPeterG mentioned this pull request Sep 3, 2024

Initial port to nautobot 2 nautobot/terraform-provider-nautobot#17

Merged

TobiPeterG added 7 commits September 6, 2024 10:46

Add temporary branch for terraform

2f6abbe

Make cloud_account_count not required for Manufacturer

11cc935

Remove all _count properties from Manufacturer's required list

87f7d48

Remove all _count parameters from required list

e00feef

Document what needs to be fixed in spec patcher

660fbea

Update to Nautobot 2.3.2

fe6c860

Correctly fix PowerFeed and Prefix

c2c6625

chadell reviewed Sep 6, 2024

View reviewed changes

.travis.yml Outdated Show resolved Hide resolved

Remove .travis.yml

58ffcc5

chadell reviewed Sep 9, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

chadell reviewed Sep 9, 2024

View reviewed changes

README.md Show resolved Hide resolved

chadell reviewed Sep 9, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

chadell reviewed Sep 9, 2024

View reviewed changes

README.md Show resolved Hide resolved

chadell reviewed Sep 9, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

chadell reviewed Sep 9, 2024

View reviewed changes

README.md Show resolved Hide resolved

Fix AvailableIP spec

b875a8e

TobiPeterG force-pushed the openapi-fix-spec branch 2 times, most recently from da86890 to 3da61de Compare September 15, 2024 09:42

chadell reviewed Sep 16, 2024

View reviewed changes

.README.md Outdated

check(err)

config := nb.NewConfiguration()

config.Servers[0].URL = "localhost"

Copy link

Contributor

chadell Sep 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

demo.nautobot.com ?

Use manual README and release workflow

e8af195

TobiPeterG force-pushed the openapi-fix-spec branch from 3da61de to e8af195 Compare September 16, 2024 10:12

chadell approved these changes Sep 16, 2024

View reviewed changes

chadell merged commit 117bd94 into nautobot:main Sep 16, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Openapi fix spec #30

Openapi fix spec #30

TobiPeterG commented Aug 26, 2024

TobiPeterG commented Aug 27, 2024

glennmatthews Aug 27, 2024

glennmatthews Aug 27, 2024

glennmatthews Aug 27, 2024

glennmatthews Aug 27, 2024

glennmatthews Aug 27, 2024

TobiPeterG Aug 27, 2024

glennmatthews Aug 27, 2024

TobiPeterG Aug 28, 2024

glennmatthews Aug 27, 2024

glennmatthews Aug 27, 2024

TobiPeterG Aug 27, 2024

glennmatthews Aug 27, 2024

glennmatthews Aug 27, 2024

glennmatthews Aug 27, 2024

glennmatthews Aug 27, 2024

TobiPeterG commented Sep 6, 2024

chadell Sep 9, 2024

TobiPeterG Sep 14, 2024 •

edited

Loading

chadell Sep 16, 2024

chadell Sep 16, 2024

chadell left a comment


		- [Network Automation with Go Book](https://github.com/PacktPublishing/Network-Automation-with-Go/blob/main/ch06/nautobot/main.go)

Openapi fix spec #30

Openapi fix spec #30

Conversation

TobiPeterG commented Aug 26, 2024

TobiPeterG commented Aug 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TobiPeterG commented Sep 6, 2024

Choose a reason for hiding this comment

TobiPeterG Sep 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chadell left a comment

Choose a reason for hiding this comment

TobiPeterG Sep 14, 2024 •

edited

Loading