Summary
- Added new schemas for
UserTeamMembershipandUserTeamsPaginatedto manage team memberships and pagination. - Enhanced
Clusterschema with new properties for Disaster Recovery (DR) support, includingdrRegion,isDrEnabled, and others. - Introduced new permissions for managing environment objects and API tokens within organizations.
- Removed
astroRuntimeVersionproperty from deployment update requests. - Updated sorting options and descriptions for listing user teams within an organization.
Added
-
Schemas:
UserTeamMembershipdagRoles: Array of DAG roles.deploymentRoles: Array of deployment roles.description: String, example: ‘My Team description’.id: String, example: ‘clma5ftgk000008mhgev00k7d’.isIdpManaged: Boolean, example: False.name: String, example: ‘My Team’.organizationRole: Enum with values like ‘ORGANIZATION_OWNER’, ‘ORGANIZATION_MEMBER’, etc.rolesCount: Integer, example: 1.workspaceRoles: Array of workspace roles.
UserTeamsPaginatedlimit: Integer, example: 10.offset: Integer, example: 0.teams: Array ofUserTeamMembership.totalCount: Integer, example: 100.
ClusterdrRegion: String, example: ‘us-east-1’.drSecondaryVpcCidr: String.drVpcSubnetRange: String.enableReplicationTimeControl: Boolean.failoverInProgress: Boolean.isDrEnabled: Boolean.isFailedOver: Boolean.
CreateAwsClusterRequest,CreateAzureClusterRequest,CreateGcpClusterRequestdrRegion: String, example: ‘us-west-2’.drSecondaryVpcCidr: String, example: ‘100.64.0.0/19’.drVpcSubnetRange: String, example: ‘172.20.0.0/22’.enableReplicationTimeControl: Boolean.
CreateDedicatedDeploymentRequest,CreateHybridDeploymentRequest,CreateStandardDeploymentRequestdrWorkloadIdentity: String, example: ‘arn:aws:iam::123456789:role/AirflowS3Logs-clmk2qqia000008mhff3ndjr0’.
DeploymentdrExternalIPs: Array of strings.drOidcIssuerUrl: String, example: ‘https://westus2.oic.prod-aks.azure.com/…’.effectiveDRWorkloadIdentity: String.
UpdateDedicatedClusterRequestenableDr: Boolean.isFailedOver: Boolean.
UpdateDedicatedDeploymentRequest,UpdateHybridDeploymentRequest,UpdateStandardDeploymentRequestdrWorkloadIdentity: String.environmentVariables: List of environment variables.
-
Permissions:
/organizations/{organizationId}/environment-objectsand related endpoints:organization.envObjects.access./organizations/{organizationId}/tokensand related endpoints:organization.apiTokens.access./organizations/{organizationId}/users/{userId}/roles:organization.userRoles.access.
Changed
-
Schemas:
ClustersecondaryVpcCidrdescription updated to “The secondary VPC CIDR. For AWS clusters only.”- Added
drRegion,isDrEnabled, andnameto required fields.
OrganizationProductPlan- Added
ENTERPRISE_BUSINESS_CRITICALtoproductPlanNameenum.
- Added
-
Endpoints:
/organizations/{organizationId}/users/{userId}/teams- Response schema changed from
TeamsPaginatedtoUserTeamsPaginated. - Permission action changed from
organization.users.gettoorganization.teams.get. - Updated descriptions for parameters and summary.
- Response schema changed from
-
Removed:
astroRuntimeVersionfromUpdateDedicatedDeploymentRequest,UpdateHybridDeploymentRequest, andUpdateStandardDeploymentRequest.
Summary
- Added a new endpoint to list all Teams associated with a specific user.
Added
- Endpoints
GET /organizations/{organizationId}/users/{userId}/teams: List all Teams that a user belongs to within an Organization. Supports pagination withoffsetandlimitquery parameters, and sorting with thesortsquery parameter.
v1 API Changelog
Summary
- Added discriminators to
CreateClusterRequest,CreateDeploymentRequest,UpdateClusterRequest, andUpdateDeploymentRequestschemas. Discriminators remove ambiguity when creating or updating resources by mapping requests to the correct cloud provider or Deployment type. - Updated descriptions for
ApiTokenRoleand API token listing parameters.
Added
- CreateClusterRequest Schema:
- Discriminator on
cloudProviderwith mappings forAWS,AZURE, andGCP.
- Discriminator on
- CreateDeploymentRequest Schema:
- Discriminator on
typewith mappings forDEDICATED,HYBRID, andSTANDARD.
- Discriminator on
- UpdateClusterRequest Schema:
- Discriminator on
clusterTypewith mappings forDEDICATEDandHYBRID.
- Discriminator on
- UpdateDeploymentRequest Schema:
- Discriminator on
typewith mappings forDEDICATED,HYBRID, andSTANDARD.
- Discriminator on
Changed
- UpdateDedicatedDeploymentRequest, UpdateHybridDeploymentRequest, UpdateStandardDeploymentRequest Schemas:
- Removed description for
environmentVariables.
- Removed description for
- ApiTokenRole Schema:
- Updated description for
entityId.
- Updated description for
- API Token Listing Endpoint:
- Updated description for the parameter related to DAG tags.
v1 API Changelog
Summary
- Added new properties to the
DagRole,Deployment, andTeamschemas to enhance DAG access management. - Introduced new query parameters for pagination and sorting in the
/organizations/{organizationId}/tokensand/organizations/{organizationId}/usersendpoints.
Added
- Schemas
DagRoledagTag: DAG tag, required ifDagIdis not specified.
DeploymentEnvironmentVariableupdatedAt: Format set todate-time.
InviteexpiresAt: Format set todate-time.
RolecreatedAtandupdatedAt: Examples and format set todate-time.
RoleWithPermissioncreatedAtandupdatedAt: Examples and format set todate-time.
TeamdagRoles: Array of DAG roles.
- Endpoints
/organizations/{organizationId}/tokenslimit: Limit for pagination.sorts: Sorting criteria.
/organizations/{organizationId}/userslimit: Limit for pagination.sorts: Sorting criteria.
- Enums
ApiTokenRoleentityType: AddedDAG_TAG.
Initial release of the v1 Astro API.
See Migrate to v1 for key changes and migration steps.