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

Generate new version of SDK from fabric-api-specification version 4.10 #32

Merged
merged 2 commits into from
Oct 13, 2023

Conversation

srushti-patl
Copy link
Contributor

@srushti-patl srushti-patl commented Oct 12, 2023

October Release Notes: https://uatdeveloper.equinix.com/docs?page=/dev-docs/fabric/overview

Release Overview

Release date: October 14th, 2023

Equinix Fabric API specification on SwaggerHub: app.swaggerhub.com
Equinix Fabric v4 API reference guide: Fabric APIs (v4)

Feature Summary of Release
Routing Protocol APIs Added new API to Validate Subnet
Port APIs Added new API to Search Ports
Cloud Router APIs Added "distinctIpv4PrefixesCount" and "distinctIpv6PrefixesCount" fields to Get Specified Cloud Router

Enhancements

  • Account model added
  • AdvanceConfiguration model added
  • Connection model updated
  • ConnectionLink model added
  • ConnectionPostRequest model updated
  • CloudRouterActionState model updated
  • CloudRouterActionTypeTest model updated
  • FabricConnectionUuid model added
  • FabricCloudRouterCode model updated
  • FabricCloudRouterPackages model updated
  • FabrciCloudrouterPrice model updated
  • GeoScopeType model added
  • Ipv4 model added
  • Md5 model added
  • Metro model updated
    -PortsApi ` method added
  • PackageRequest model added
  • PortSearchFieldName model updated
  • PortV4SearchRequest model added
  • PortsApiTest model updated
  • PrecisiontimeApi model added
  • PrecisionTimeChangeOperation model added
  • PrecisionTimeServiceConnectionResponses model added
  • PrecisionTimeServiceCreateResponse model added
  • PrecisionTimeServicePackageResponse model added
  • PrecisionTimeServiceRequest model added
  • PtpAdvanceConfiguration model added
  • Price model updated
  • RoutesApi model removed
  • RoutingProtocolApi model updated
  • ValidateConnectionRequestFilter model deleted
  • ValidateSubnetRequest model added
  • ValidateSubnetRequestFilter model updated
  • ValidateSubnetRequestFilterAnd model updated
  • ValidateSubnetResponse model added
  • SearchPorts method

Breaking Changes

  • CloudRouterAPI *Gateway* methods renamed to *CloudRouter*
  • ValidateConnectionRequestFilter renamed to ValidateSubnetRequestFilter
  • SearchServiceProfiles method signature updated to include a third argument of type *ServiceProfilesApiSearchServiceProfilesOpts

Release Overview
Release date: October 14th, 2023

Additional Changes Not Present in Release Notes:

  • Gateway Methods renamed to CloudRouter. Operation IDs in OAS were renamed causing the method rename.

@@ -0,0 +1,17 @@

Copy link
Member

@displague displague Oct 13, 2023

Choose a reason for hiding this comment

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

It would be helpful to include in this PR description or a comment, for inclusion in the release notes, what models were added, renamed, removed, and where the model is an existing one what properties and public methods were added, renamed, and removed. These could link to the markdown doc, which is something we can do later in the release notes since the PR based links could break.

Largely inspired by https://developer.hashicorp.com/terraform/plugin/best-practices/versioning#changelog-specification, this could look like:

Enhancements

  • Account model added
  • AdvanceConfiguration model added
  • ConnectionLink model added

Breaking Changes

  • CloudRouterAPI *Gateway* methods renamed to *CloudRouter*
  • ... renamed to ...
  • ... removed
  • Foo fields ..., ... added / removed / renamed
  • FooAPI fooByFoo method added

If there is a Java package differ tool available, we could ideally automate this.

Copy link
Contributor

@thogarty thogarty left a comment

Choose a reason for hiding this comment

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

LGTM

@thogarty thogarty merged commit 84c317a into main Oct 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants