Skip to content

Commit e18419e

Browse files
jrdevorejrdevore
authored
RLP-157119 and PCSUP-29545: Documentation Only fix (cspm): remove features array from cloud account list endpoints (#1044)
* Documenation Only fix (cspm): remove features array from cloud account list endpoints Fixes RLP-157119 and PCSUP-29545 The GET /cloud and GET /cloud/{cloud_type}/{id}/project endpoints documented a 'features' array in their response schemas, but the actual API implementation does not return this field for list operations. Created a new CloudAccountListViewModel schema specifically for list endpoints that matches the API's actual response structure without the features array. - Added CloudAccountListViewModel schema - Duplicates CloudAccountViewModel properties except features array - Used by list endpoints that return summary views - Updated GET /cloud endpoint (line 658) - Changed response schema to CloudAccountListViewModel - update description to clarify list vs detail views - Updated GET /cloud/{cloud_type}/{id}/project endpoint (line 1951) - Changed response schema to CloudAccountListViewModel - update description to clarify list vs detail views * duplicate tag removal, fix markdown links in GET /cloud and GET /cloud/{cloud_type}/{id} descriptions - openapi-specs/cspm/CloudAccountOnboardingMicroServices.json
1 parent fa04b14 commit e18419e

1 file changed

Lines changed: 157 additions & 9 deletions

File tree

‎openapi-specs/cspm/CloudAccountOnboardingMicroServices.json‎

Lines changed: 157 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@
1717
"name": "Cloud Accounts (AWS)",
1818
"description": "To monitor the resources on your AWS cloud infrastructure, you must first add your AWS accounts to Prisma Cloud. When you add your cloud account to Prisma Cloud, the API integration between AWS and Prisma Cloud is established and you can begin monitoring the resources and identify potential security risks.\n\nThe Cloud Account (AWS) APIs enable you to add and manage AWS accounts on Prisma Cloud. For end to end workflow to onboarding an AWS account using APIs, see [Automate AWS Cloud Account Onboarding](/prisma-cloud/docs/cspm/aws-cloud-account-onboarding/).\n For common operations related to cloud accounts, see [Cloud Accounts (All)](/prisma-cloud/api/cspm/cloud-accounts-all/).\n"
1919
},
20-
{
21-
"name": "AWS Logging Accounts",
22-
"description": "To ingest the VPC flow logs from Amazon S3 buckets to Prisma Cloud, you need an AWS logging account. If you need flow logs ingestion, after onboarding your AWS account, you must onboard the logging account which has the S3 bucket storing VPC flow logs for the monitored account. The APIs in this category can be used to configure and manage these logging accounts."
23-
},
2420
{
2521
"name": "Cloud Accounts (All)",
2622
"description": "You can use the APIs in this category to perform operations that are nonspecific to cloud account types, such as listing all the cloud accounts, listing supported features, and deleting an account.\n\nFor operations that are specific to the cloud type or cloud provider, see:\n* [Cloud Accounts (AWS)](/prisma-cloud/api/cspm/cloud-accounts-aws/)\n* [Cloud Accounts (Azure)](/prisma-cloud/api/cspm/cloud-accounts-azure/) \n* [Cloud Accounts (GCP)](/prisma-cloud/api/cspm/cloud-accounts-gcp/)\n* [Cloud Accounts (OCI and Alibaba)](/prisma-cloud/api/cspm/cloud-accounts-oci-and-alibaba/)\n"
@@ -661,7 +657,7 @@
661657
"Cloud Accounts (All)"
662658
],
663659
"summary": "Get all Cloud Accounts",
664-
"description": "Get details of all the cloud accounts onboarded onto Prisma Cloud. To get details of cloud accounts based on cloud type or account ID, see [Get Cloud Account Details] (https://pan.dev/prisma-cloud/api/cspm/get-cloud-account/).",
660+
"description": "Get summary details of all the cloud accounts onboarded onto Prisma Cloud. This endpoint returns a list view without the features array. To get complete details of a specific cloud account including features, see [Get Cloud Account Details](/prisma-cloud/api/cspm/get-cloud-account).",
665661
"operationId": "get-cloud-accounts",
666662
"parameters": [
667663
{
@@ -690,7 +686,7 @@
690686
"schema": {
691687
"type": "array",
692688
"items": {
693-
"$ref": "#/components/schemas/CloudAccountViewModel"
689+
"$ref": "#/components/schemas/CloudAccountListViewModel"
694690
}
695691
}
696692
}
@@ -1708,7 +1704,7 @@
17081704
"Cloud Accounts (All)"
17091705
],
17101706
"summary": "Get Cloud Account Details",
1711-
"description": "Returns details of a Cloud Account based on cloud type and cloud ID. To get details of all the cloud accounts onboarded to Prisma Cloud, see [List Cloud Accounts](https://pan.dev/prisma-cloud/api/cspm/get-cloud-accounts/).",
1707+
"description": "Returns details of a Cloud Account based on cloud type and cloud ID. To get details of all the cloud accounts onboarded to Prisma Cloud, see [Get all Cloud Accounts](/prisma-cloud/api/cspm/get-cloud-accounts).",
17121708
"operationId": "get-cloud-account",
17131709
"parameters": [
17141710
{
@@ -1954,7 +1950,7 @@
19541950
"Cloud Accounts (All)"
19551951
],
19561952
"summary": "Get Cloud Org Accounts",
1957-
"description": "Get details of all the cloud accounts onboarded onto the Prisma Cloud as children of an organization that belongs to a specific cloud type.",
1953+
"description": "Get summary details of all the cloud accounts onboarded onto Prisma Cloud as children of an organization that belongs to a specific cloud type. This endpoint returns a list view without the features array. To get complete details of a specific cloud account including features, see [Get Cloud Account Details](https://pan.dev/prisma-cloud/api/cspm/get-cloud-account/).",
19581954
"operationId": "get-cloud-org-accounts",
19591955
"parameters": [
19601956
{
@@ -2000,7 +1996,7 @@
20001996
"schema": {
20011997
"type": "array",
20021998
"items": {
2003-
"$ref": "#/components/schemas/CloudAccountViewModel"
1999+
"$ref": "#/components/schemas/CloudAccountListViewModel"
20042000
}
20052001
}
20062002
}
@@ -4214,6 +4210,158 @@
42144210
}
42154211
}
42164212
},
4213+
"CloudAccountListViewModel": {
4214+
"type": "object",
4215+
"properties": {
4216+
"parentAccountId": {
4217+
"type": "string"
4218+
},
4219+
"name": {
4220+
"type": "string",
4221+
"description": "Name"
4222+
},
4223+
"cloudType": {
4224+
"type": "string",
4225+
"description": "Cloud Type",
4226+
"readOnly": true,
4227+
"enum": [
4228+
"ALL",
4229+
"AWS",
4230+
"AZURE",
4231+
"GCP",
4232+
"ALIBABA_CLOUD",
4233+
"OCI",
4234+
"OTHER"
4235+
]
4236+
},
4237+
"accountType": {
4238+
"type": "string",
4239+
"description": "Cloud Account Type",
4240+
"readOnly": true,
4241+
"enum": [
4242+
"ACCOUNT",
4243+
"MASTER_SERVICE_ACCOUNT",
4244+
"COMPARTMENT",
4245+
"ORGANIZATION",
4246+
"TENANT"
4247+
]
4248+
},
4249+
"enabled": {
4250+
"type": "boolean",
4251+
"description": "Enabled"
4252+
},
4253+
"lastModifiedTs": {
4254+
"type": "integer",
4255+
"format": "int64",
4256+
"description": "Time account was last updated",
4257+
"readOnly": true
4258+
},
4259+
"lastModifiedBy": {
4260+
"type": "string",
4261+
"description": "Last Modified By",
4262+
"readOnly": true
4263+
},
4264+
"storageScanEnabled": {
4265+
"type": "boolean",
4266+
"description": "Storage Scan Enabled"
4267+
},
4268+
"storageUUID": {
4269+
"type": "string",
4270+
"description": "Storage UUID"
4271+
},
4272+
"protectionMode": {
4273+
"type": "string",
4274+
"description": "Protection Mode",
4275+
"readOnly": true,
4276+
"enum": [
4277+
"MONITOR",
4278+
"MONITOR_AND_PROTECT"
4279+
]
4280+
},
4281+
"cloudAccountOwner": {
4282+
"type": "string",
4283+
"description": "Cloud account owner"
4284+
},
4285+
"deploymentType": {
4286+
"type": "string",
4287+
"description": "Deployment Type",
4288+
"enum": [
4289+
"AZURE",
4290+
"AZURE_GOVERNMENT",
4291+
"AZURE_CHINA",
4292+
"AWS",
4293+
"AWS_GOVERNMENT",
4294+
"AWS_CHINA",
4295+
"OCI",
4296+
"OCI_GOVERNMENT",
4297+
"OCI_CHINA",
4298+
"GCP",
4299+
"GCP_GOVERNMENT",
4300+
"GCP_CHINA",
4301+
"ALIBABA_CLOUD",
4302+
"ALIBABA_CLOUD_GOVERNMENT",
4303+
"ALIBABA_CLOUD_CHINA",
4304+
"ALIBABA_CLOUD_FINANCE"
4305+
]
4306+
},
4307+
"associatedAccountGroupsCount": {
4308+
"type": "integer",
4309+
"format": "int32",
4310+
"description": "Associated Account Groups Count with this cloud account"
4311+
},
4312+
"accountGroupInfos": {
4313+
"type": "array",
4314+
"description": "Account group details of groups associated with this account",
4315+
"items": {
4316+
"$ref": "#/components/schemas/AccountGroupInfo"
4317+
}
4318+
},
4319+
"cloudAccountOwnerCount": {
4320+
"type": "integer",
4321+
"format": "int32",
4322+
"description": "Cloud account owner count",
4323+
"readOnly": true
4324+
},
4325+
"groups": {
4326+
"type": "array",
4327+
"description": "Groups",
4328+
"readOnly": true,
4329+
"items": {
4330+
"type": "object",
4331+
"additionalProperties": {
4332+
"type": "object"
4333+
}
4334+
}
4335+
},
4336+
"status": {
4337+
"type": "string",
4338+
"description": "Account Config Status"
4339+
},
4340+
"numberOfChildAccounts": {
4341+
"type": "integer",
4342+
"format": "int32"
4343+
},
4344+
"accountId": {
4345+
"type": "string",
4346+
"description": "Account ID"
4347+
},
4348+
"addedOn": {
4349+
"type": "integer",
4350+
"format": "int64",
4351+
"description": "Added On",
4352+
"readOnly": true
4353+
},
4354+
"groupIds": {
4355+
"type": "array",
4356+
"description": "Group Ids",
4357+
"readOnly": true,
4358+
"items": {
4359+
"type": "string"
4360+
}
4361+
}
4362+
},
4363+
"description": "Model for Cloud Account List View - used by list endpoints that do not return the features array"
4364+
},
42174365
"CloudAccountViewModel": {
42184366
"type": "object",
42194367
"properties": {

0 commit comments

Comments
 (0)