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.

Sign up for GitHub

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

Jump to bottom

feat: Fabric 4.17 api spec update #80

Merged
merged 4 commits into from
Oct 15, 2024
Merged

feat: Fabric 4.17 api spec update #80

merged 4 commits into from
Oct 15, 2024

Conversation

thogarty
Copy link
Contributor

@thogarty thogarty commented Oct 14, 2024 •
edited
Loading

  • Remove unused API spec Patching that was fixed in API Spec source
  • Add post patching for newly generated API Streams test file
  • Update Fabric API Spec version to 4.17

Changes in SDK

Enhancements

  • Additional methods ->

    • Methods added for Cloud Router Actions
    • Methods added for Cloud Router Connections advertisedRoutes and receivedRoutes searching
    • Methods for Precision Time PUT endpoint
    • Methods added for Stream Subscriptions Product
    • Methods added for Streams Product

  • Additional models ->

    • Models added for Cloud Router Actions Product
    • ServiceToken model used for API Responses
    • Models added for Stream Subscriptions Product and for Streams Product
      • Asset Enum
      • ActionRequest
      • ActionResponse
      • ActionState
      • ActionType
      • ActionsSearchExpression
      • ActionsSearchFilter
      • ActionsSearchFilters
      • ActionsSearchOrFilter
      • ActionsSearchRequest
      • ActionsSearchResponse
      • ActionsSearchSortBy
      • ActionsSearchSortCriteria
      • ActionsSearchSortDirection
      • ConnectionRouteEntryFilter
      • ConnectionRouteEntryFilters
      • ConnectionRouteEntryOrFilter
      • ConnectionRouteEntrySimpleExpression
      • ConnectionRouteEntrySortBy
      • ConnectionRouteEntrySortDirection
      • ConnectionRouteSearchRequest
      • ConnectionRouteSortCriteria
      • ConnectionRouteTableEntry
      • ConnectionRouteTableEntryConnection
      • ConnectionRouteTableEntrySearchResponse
      • ConnectionRouteTableEntryState
      • GetAllStreamAssetResponse
      • GetAllStreamResponse
      • GetAllStreamSubscriptionResponse
      • GetSubscriptionsInStreamResponse
      • Operation
      • Package
      • PackageCode
      • PackageType
      • Stream
      • StreamAsset
      • StreamAssetAttachmentStatus
      • StreamAssetFilter
      • StreamAssetFilters
      • StreamAssetOrFilter
      • StreamAssetPutRequest
      • StreamAssetSearchRequest
      • StreamAssetSimpleExpression
      • StreamAssetSortBy
      • StreamAssetSortCriteria
      • StreamAssetSortDirection
      • StreamFilter
      • StreamFilterOrFilter
      • StreamFilterSimpleExpression
      • StreamGetSubscriptions
      • StreamGetSubscriptionsType
      • StreamPostRequest
      • StreamPostRequestType
      • StreamPutRequest
      • StreamSubscription
      • StreamSubscriptionFilter
      • StreamSubscriptionPostRequest
      • StreamSubscriptionPostRequestType
      • StreamSubscriptionPutRequest
      • StreamSubscriptionSink
      • StreamSubscriptionSinkCredential
      • StreamSubscriptionSinkSetting
      • StreamSubscriptionSinkType
      • StreamSubscriptionState
      • StreamSubscriptionType
      • StreamTarget
    • BulkPortRequest added to replace BulkPort in request methods
    • PhysicalPortSettings
    • PortBMMRType
    • PortConnectivitySourceType
    • PortRequest
    • PortServiceType
    • PrecisionTimeOrder
    • PrecisionTimePackageCode
    • PrecisionTimeServiceResponseState
    • PrecisionTimeServiceResponseType
    • LogAnnounceInterval
    • LogSyncInterval
    • LogDelayReqInterval
    • RouterActionsConnection
    • SimplifiedTokenNetwork
    • SimplifiedTokenNetworkScope
    • SimplifiedTokenNetworkType
    • SimplifiedVirtualDevice
    • SimplifiedVirtualDeviceType
    • SubscriptionState
    • ValidateConnectionResponse
    • VirtualConnectionSide
    • VirtualConnectionTimeServiceResponse
    • VirtualDeviceInterface

  • Models extended ->

    • ApiGetServiceTokenByUuidRequest added offset and limit attributes
    • AccessPointSelector added VirtualDevice, Interface, and Network as attributes
    • bgp_connection_ipv4 and bgp_connection_ipv6 added RoutesMax attribute
    • PhysicalPort added UUID, Settings, and Interface attributes
    • PortOperation added EvplVCCount, FgVCCount, and AccessVCCount
    • PortPurchaseOrder added Type attribute
    • ServiceToken added IssuerSide attribute
    • ServiceTokenConnection added AllowCustomBandwidth
    • SimplifiedMetadataEntity

  • Constants added ->

    • AccessPointSelectType added ACCESSPOINTSELECTORTYPE_VD and ACCESSPOINTSELECTORTYPE_NETWORK
    • CLOUDROUTERACCESSPOINTSTATE_REPROVISIONING added
    • PORTOPERATIONOPERATIONALSTATUS_PARTIAL added
    • PortOrderPurchaseOrderType added
    • PhysicalPortsType added
    • PRECISIONTIMECHANGEOPERATIONOP_ADD and PRECISIONTIMECHANGEOPERATIONOP_REMOVE added
    • Additional PRECISIONTIMECHANGEOPERATIONPATHs for changes
    • Additional SERVICETOKENCONNECTIONTYPEs
    • ServiceTokenIssuerSide added
    • SERVICETOKENTYPE_EPL_TOKEN added
    • VirtualDeviceInterfaceType

Breaking Changes

  • Methods changed ->

    • Ports Method signature changes because of model renames;
      • BulkPort used instead of AllPortsResponse
      • BulkPortRequest used instead of BulkPort
    • Precision Time Method signature changes because of model renames
    • Service Tokens method signature changes because addition of ServiceToken model
    • CloudRouterChangeOperation now uses PrecisionTimeChangeOperationOp instead of ServiceTokenChangeOperationOp for changes
    • NetworkChangeOperation now uses PrecisionTimeChangeOperationOp instead of ServiceTokenChangeOperationOp for changes
    • ServiceTokenOperation now uses PrecisionTimeChangeOperationOp instead of ServiceTokenChangeOperationOp for changes

  • Models changed ->

    • ApiCreatePortRequest; Port renamed to PortRequest
    • PortResponse renamed to Port
    • PrecisionTimeServiceCreateResponse renamed to PrecisionTimeServiceResponse
    • AccessPointSelector LinkProtocol attribute changed from LinkProtocol type to SimplifiedLinkProtocol type
    • AllPortsResponse uses []Port instead of []PortResponse
    • ConnectionResponse uses []ValidateConnectionResponse instead of []BaseConnection
    • Ipv4 attributes Primary, Secondary, and NetworkMask are required attributes
    • MD5 renamed Id -> KeyNumber and Password -> Key
    • Port model no longer has required fields
    • PrecisionTimeServiceRequest split AdvanceConfiguration into NtpAdvanceConfiguration and PtpAdvanceConfiguration
      • FabricConnectionUuid changed to VirtualConnectionUuid as well
    • PrecisionTimeServiceResponse split AdvanceConfiguration into NtpAdvanceConfiguration and PtpAdvanceConfiguration
      • FabricConnectionUuid changed to VirtualConnectionTimeServiceResponse
    • PTPAdvanceConfiguration uses explicit types for:
      • LogAnnounceInterval
      • LogSyncInterval
      • LogDelayReqInterval
    • RouteTableEntry
    • SimplifiedPort:
      • Removed CvpId and modified int32 to int64 on integer attributes
      • Added Package
    • SubscriptionAsset
    • SubscriptionResponse
    • FabricConnectionUuid renamed to VirtualConnectionUuid

  • Models Deleted ->

    • Account model removed in favor of SimplifiedAccount
    • AdvanceConfiguration model removed in favor of bringing NTP and PTP to a higher level for Precision Time
    • PortResponse deleted in favor of modified Port model (no required fields)
    • BaseConnection deleted in favor of modified ValidateConnectionResponse
    • CLOUDROUTERACCESSPOINTSTATE_LOCKED deleted
    • LinkProtocol deleted in favor of SimplifiedLinkProtocol
    • LinkProtocolDot1q deleted
    • LinkProtocolEVPN_VXLan deleted
    • LinkProtocolIpv4Ipv6Config deleted
    • LinkProtocol QINQ deleted
    • LinkProtocolUntagged deleted
    • LinkProtocolVXLan deleted
    • PortResponseBMMRType
    • PortResponseConnectivitySourceType
    • PortResponsePhysicalPortsType
    • PortResponseServiceType
    • PrecisionTimePackageRequest
    • PrecisionTimeServiceCreateResponse
    • PrecisionTimeServiceCreateResponseState
    • PrecisionTimeServiceCreateResponseType
    • SimplifiedAccountPortResponse deleted in favor of SimplifiedAccount
    • SubscriptionAssetType
    • SubscriptionStatus deleted in favor of SubscriptionState

@thogarty thogarty requested a review from a team as a code owner October 14, 2024 23:22
@thogarty thogarty merged commit ccf0642 into main Oct 15, 2024
4 checks passed
@thogarty thogarty deleted the fabric_4.17_api_spec_update branch October 15, 2024 21:44
@github-actions GitHub Actions
Copy link
Contributor

This PR is included in version 0.46.0 🎉

@thogarty thogarty mentioned this pull request Oct 15, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@srushti-patl srushti-patl srushti-patl approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@thogarty @srushti-patl