This document describes the relevant changes between releases of the API model.
- Add
Subnets
field to MachinePool type.
- Add
ExcludeSubscriptionStatuses
field to ResourceReview type.
- Add
BillingMarketplaceAccount
field to ReservedResource type.
- Remove volume type from flavour
- Add Network Configuration for Managed Services
- Add
MarketplaceAWS
,MarketplaceAzure
,MarketplaceRHM
billing models.
- Add
CloudAccount
type. - Add
CloudAccounts
field to QuotaCost type. - Add
BillingMarketplaceAccount
field to Subscription type.
- Adding groups claim to openID IDP
- Add
hypershift.enabled
field to cluster type.
- Fix cred request api model parameters
- Add cred request to api model
- Add AWSRegionMachineTypes endpoint to api model
- Change inflight check type Details field to Interface
- Added Machine Pool Security Group Filters for Machine Pools and Cluster Nodes
- Drop RoleARN from AddOnInstallation
- Added Import method to the HTPasswd IDP user collection.
- Added availability zone fields to managed service cluster struct.
- Add LimitedSupportReasonCount to cluster status struct.
- Add FullNames and LimitScope param fields for status-board status updates.
- Add Update method for
service_mgmt
- Add inflight checks and 'validating' state.
- Add STS missing fields.
- Fix JSON representation of log severity.
- Fix JSON names of identity provider types.
- Add enable minor version upgrades flag to upgrade policy.
- Added QuotaRules to ocm-sdk-go
- added no_proxy field to the proxy project
- Added errors resource.
- Added errors support for status-board.
- Add Status query param for incidents resource.
- Add new
web_rca
service.
- Add ManagementCluster to ProvisionShard.
- Fixes for
CloudResources
resource.
- Added field for parameters to be specified for managed services.
- Added CloudResource type and resources.
- Added field for parameters to be specified for managed services.
- Adding
service_mgmt
service.
- add aws sts policy
- Add ReleaseImage to Version
- Add CloudProvider info to ProvisionShard
- Fix cluster logs URL, should be
cluster_logs
instead ofcluster_logs_uuid
.
- Add
managed_service
field to add-on type. - Add
credentials_secret
field to add-on type. - Add
region
field to provision shard.
-
Fix update method of environment endpoint, should be
Update
instead ofPatch
. -
Remove unimplemented
POST /api/service_logs/v1/cluster_logs/clusters/{uuid}/cluster_logs
method.
- Add environment endpoint get and patch
- Add new apis for addon config attribute
- Add list of requirements to addon parameter options
- Add Name fields to VPCs and Subnetworks
- Rename addon config env object
- Add rhit_account_id to Account Class
- addons: Support attributes necessary for STS.
- Add ProductIds param to Status Resource.
- Add Role bindings to Subscription.
- Remove deprecated quota summary resource and type.
- Add QuotaVersion to ClusterAuth.
- Allow adding/removing operator roles.
- Remove deprecated
SKUs
endpoint
- Add
ServiceInfo
type status board service.
- Version gate type: Add warning message field
- Fix description of various API attributes
- OVN: Add network type selection
- adding field to hold validation error message
- Change field name in version gate agreement link to version gate.
- Change version gate agreement URL.
- Add version raw id prefix to version gate.
- Move version gates to be top level resource.
- Add support for version gate deletion.
- Add support for version gate creation.
- Add support for version gate agreements.
- Change version gates URL.
- Add version gates support.
- Adding subnetworks to vpc inquiry
- Add statuses path to service model, add some comments.
- [SDB-2509] Update OSL API schema to be compatible with ocm-sdk-go
- Add support for multi-user
HTPasswd
IDP.
- Add
updates
method to status board product resource. - Fix status get method of status board.
- Add
status_board
service.
This version doesn't contain changes to the model, only to the development and build workflows:
-
Rename
master
branch tomain
.To adapt your local repository to the new branch name run the following commands:
git branch -m master main git fetch origin git branch -u origin/main main git remote set-head origin -a
-
Automatically add changes from
CHANGES.md
to release descriptions.
- Enable FIPS mode
- Update type
resource
toclusterResources
- Revert "Add Name field to LDAP identity provider"
- Remove addon install mode
singleNamespace
- Add addon install mode
ownNamespace
- Add channel to addon version class
- Add Name field to LDAP identity provider
- Fix addon installation version (addon_version vs version)
- Remove no_proxy attribute from SDK
- Add body to the external tracking event
- Add AddOn Versions
- Revert archived cluster endpoint
- Add missing connection to clusters collection in the
service_logs
service.
- Add Status to AddOnRequirement
- Add Archived cluster endpoint
- Add cluster waiting state
- Add cluster-wide proxy and gcp network attributes
- Add Add() method to limited support reasons resource
- Add Limited Support Reason and Templates API
- Add EndOfLifeTimestamp for versions
- Add check_optional_terms to TermsReview and SelfTermsReview
- Add reduceClusterList to ResourceReview and SelfResourceReview
- Add kms key arn to aws ccs cluster encryption
- Add addon inquiries endpoints get and list
- Add cluster resource type
- Remove GET cluster deployment endpoint
- Added Spot Market Options to MachinePool
- Added username to service log LogEntry
- Added InternalOnly flag to SubscriptionNotify
- Added capabilities support to Organization
- Add ccs_only flag for cloud regions
- Add Feature Review and Self Feature Review Locators
- Add Disable workload monitoring Field to Cluster Type
- Add Authorizations Feature Review and Self Feature Review
- Add cloud provider inquiries to api-model
- sts: Add support role ARN
- Add CCSOnly, GenericName fields to machine type.
- Add AcceleratedComputing value to MachineTypeCategory enum.
- Remove the Dashboards resource.
- Add ClusterConfigurationMode type under ClusterStatus
- sts: Change custom roles to instance roles
- Added Custom IAM roles For STS
- JobQueue: Updated attributes of Push
- [SDB-2062] remove fields on ResourceQuota
- JobQueue: Attribute Arguments added to Pop
- JobQueue: Attributes to Pop changed
- JobQueue: Attributes to Push changed
- STS: Support attributes to allow STS clusters
- Add 'hibernating', "powering-down' and 'resuming' cluster states.
- JobQueue: ReceiptId is String and not Integer
- Add a new service JobQueue
- Add event_code and site_code to TermsReviewRequest type
- Add new SelfTermsReviewRequest type
- related-resources: Add resource type and cloud provider
- event: Track ad-hoc authenticated events
- Add RelatedResources struct to QuotaCost
- Add Options to AddOnParameter type.
- aws: Support PrivateLink for fully-private clusters
- Add subscription metrics.
- Add
deprovision
andforce
parameters to delete cluster method. - Ensure all subscription fields are available.
- organization: Add quota_cost endpoint resources
- Remove deprecated upgrade channel group field
- Add
billing_model
attribute to theReservedResource
type. - Add
cluster_billing_model
attribute to theSubscriptioin
type.
- add addon sub operator type
- Add billing_model field to cluster type
- subscriptions: Add label locator
- Update metamodel to v0.0.36
- Add cluster hibernation support
- Add addon requirement type.
- Remove
cluster_admin_enabled
attribute from cluster type. - Add missing subscription, cluster authorization and plan attributes.
- add default value to add-on parameter type
- Add upgrade channel group for a cluster
- Fix add-on installation delete endpoint
- Remove node drain grace period from upgrade policy
- Add node drain grace period to the cluster
- Add etcd_encryption to sdk
- Add deletion add-on installation endpoint
- Add Update method to addon installation resource
- Change Taints to struct.
- Remove BYOC flag from Cluster type.
- Add Taints field to MachinePool type.
- Add Enabled to AddOnParameter type.
- Add SubnetIDs to the AWS model.
- [AMS] Add IncludeRedHatAssociates to SubscriptionNotify
- version: Rename field from MOA to ROSA
- Add RawID field to version type.
- Remove redudant fields
- flavours: Remove infra and compute nodes
- Add AddOnParameter modal type Update AddOn to include list of AddOnParameters
- Add AddOnInstallationParameter modal type Update AddOnInstallation to include list of AddOnInstallationParameters
- Add ComputeLabels attribute to ClusterNodes
- Add machine pool locator to cluster resource
- Add missing machine pools resource
- Add missing machine pool resource
- Added New Error Message implementation
- idp: Add HTPasswd provider
- Uptdating SDK with GCP credentials
- Add upgrade policy state
- Add machine pools link and type
- add external resources to add on type model
- SDA-2952 - Add "hidden" option to AddOn
- Added Install Error Details From Provisioner
- Remove redundant ID from upgrade policy class
- Add key to label_type
- Add upgrade policy type and resource
- Add terms review and self terms review
- Add dashboards summary
- Add 'available_upgrades' list to version type
- Add CCS type and Attribute to Cluster type
- Added New DNS_READY
- version: Add moa_enabled flag
- Update to metamodel v0.0.32
- Add the ChannelGroup attribute to the Version model
- Add Available AWS regions command
- Add link to missing provision shard
- Added TokenAuthorization to root_resource
- Added SupportCase resource
- [CS] Add hive_config to the provision shard
- [CS] Improving cluster logs endpoint
- [AMS] Added token authorization endpoint
- Add capability_review endpoint
- Add support_cases endpoint
- Fix comment
- Expose if a region supports multi AZ
- Add Update Identity Provider
- removing 'deprovision' suffix from logs endpoint
- add post method to subscription resource
- Add labels field to external configuration type
- Implement Batch Patch Ingresses API endpoint
- Add API for getting cluster's provision shard
- Add API for getting provision shards
- Add API for custerdeployment labels
- add organization_id to cluster_registration
- label: Fix erroneous file extensions
- MachineType: Expose instance size enum
- Added top level sku_rules endpoint to AMS
- [AMS] Changed feature toggle API to /query with payload containing organization id
- [AMS] Added SkuCount to ResourceQuota type
- Change feature toggle query API to receive organization ID by POST
- Added Syncsets API
- Added Uninstall Log
- Update to metamodel v0.0.30
- Added Notify to root_resource in AMS
- cluster: Remove support for expiration_timestamp
- Added top-level Notify endpoint to AMS
- Add subscription notify endpoint
- accounts_mgmt: Add 'fields' parameter to all list-requests
- accounts_mgmt: Support for Labels resources
- Add parameters 'offset' and 'tail' to log resource
- FeatureToggle: Add model and resource
- AddOns: Add link attribute
- Update to metamodel v0.0.28
- AddOnInstallations: Remove DELETE operation
- Added Label to Account
- Added Label to Organization
- Add enabled field to region
- Adding metrics.nodes to api model
- Adding cluster ingresses endpoint
- ClusterNodes: Add ComputeMachineType
- Network: Added HostPrefix
- Update to metamodel 0.0.27
- Add pull secret deletion
- Products: Add product attribute to cluster object
- Products: Support for top-level cluster types
- Add ClusterOperatorsConditions type
- Add ClusterAlertsFiring type and field in ClusterMetrics
- Removal of
in
parameters forGet
functions
- Update AMS Models
- Add sockets to cluster_metrics_type
- Add
Ingress
resource.
- Add
API
listening method.
- Add
ClusterAdminEnabled
flag. - Add
PullSecrets
endpoint. - Fix
LDAPIdentityProvider
attribute name.
- Add new fields to
AddOn
andAddOnInstallation
.
- Add
Organizations
attribute to GitHubIdP
- Remove duplicated attribute.
- Improve documentation of the
LogEntry
type.
- Add
client_secret
attribute to GitHub identity provider.
- Add
target_namespace
andinstall_mode
attributes toAddOn
type. - Add
state
attribute toAWSInfrastructureAccessRole
type.
- Add method to update flavour.
- Add types and resources for cluster operator metrics.
- Add
deleting
andremoved
states to AWS infrastructure access role grant status.
- Add
search
andorder
parameters to the method that lists registry credentials. - Add
labels
parameter to the method that lists subscriptions. - Add types and resources for management of AWS infrastructure access roles.
- Add new
service_logs
service. - Add types and resources for machine types.
- Add types and resources for AWS infrastructure access roles.
- Add GCP flavour and change AWS flavour to contain also the instance type.
- Fixes for
CurrentAccess
resource.
- Add
CurrentAccess
resource.
- Add
UpdatedAt
andCreatedAt
fields toSubscription
type.
- Replace
AddOns
withAddOnInstallations
.
- Add
ban_code
attribute toAccount
type.
- Add support for
ClusterUUID
field.
- Allow subscription identifier on role binding.
- Add
AddOnInstallation
type.
- Add
resource_name
andresource_cost
attributes to the add-on type.
- Remove obsolete
aws
andversion
fields from theFlavour
type. - Add instance type fields to the
Flavour
type. - Add
AWSVolume
andAWSFlavour
types. - Add attributes required for BYOC.
- Fix direction of
Body
parameters of updates.
- Allow patching role binding.
- Fix directions of paging parameters.
- Fix direction of
Body
parameter ofUpdate
. - Add default values to paging parameters.
- Update to metamodel 0.0.17.
- Add infra nodes to
FlavourNodes
. - Refactor flavour nodes.
- Add
socket_total_by_node_roles_os
metric query.
- Added add-on resources and types.
- Added subscription reserved resources collection.
- Query resource quota from root and delete by identifier.
- Added identifiers to role binding type.
- Added support to search role bindings and resource quota.
- Added
Disconnected
,DisplayName
andExternalClusterID
attributes to the cluster authorization request type.
- Added
ResourceReview
resource to the authorizations service.
- Added
search
parameter to the accountsList
method.
- Added
SKU
type. - Improved organizations.
- Improved roles.
- Added
AccessTokenAuth
type. - Added
auths
attribute toAccessToken
type. - Update to metamodel 0.0.9.
- Add
access_review
resource.
- Add
export_control_review
resource.
- Add
cpu_total_by_node_roles_os
metric query.
- Add
type
attribute to theResourceQuota
type. - Add
config_managed
attribute to theRoleBinding
type.
- Update methods don't return body.
- Add
search
parameter to theList
method of the subscriptions resource.
- Remove the
creator
attribute of theCluster
type.
- Add
order
parameter to the methods to list accounts and subscriptions.
- Update to metamodel 0.0.6: ** Explicitly enable Go modules so that the build works correctly when the project is located inside the Go path.
- Add
order
parameter to the collections that suport it. - Add cloud providers collection.
- Add
DisplayName
attribute toSubscription
type.
- Changed the type of the
ExpiresAt
attribute of theClusterRegistrationResponse
type fromlong
tostring
.