Larger Update README.md #2
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,31 @@ | ||
|
There was a problem hiding this comment. IPA-117: Documentation - The description for the There was a problem hiding this comment. IPA-112: Field Names - A new field There was a problem hiding this comment. IPA-117: Documentation - The description for the AWS connection configuration has been updated from "The configuration of AWS connection used in stream processors." to "AWS configurations for AWS-based connection types.". While this is more general, it may be less clear. Consider a description that combines both the general nature and the specific use, such as "AWS configurations for AWS-based connection types used in stream processors." |
||
| "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites": { | ||
| @@ -65185,9 +65184,13 @@ | ||
| "roleArn": { | ||
| "type": "string", | ||
| "description": "Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account." | ||
| + }, | ||
| + "testBucket": { | ||
| + "type": "string", | ||
| + "description": "The name of an S3 bucket used to check authorization of the passed-in IAM role ARN." | ||
| } | ||
| }, | ||
| - "description": "The configuration of AWS connection used in stream processors." | ||
| + "description": "AWS configurations for AWS-based connection types." | ||
| }, | ||
| "StreamsAWSLambdaConnection": { | ||
| "type": "object", | ||
|
|
||
| # testing-genai | ||
|
|
||
| "type": "string", | ||
| - "description": "Type of the connection. Can be either Cluster or Kafka.", | ||
| + "description": "Type of the connection.", | ||
| "enum": ["Kafka", "Cluster", "Sample", "Https", "AWSLambda"], | ||
| "x-xgen-IPA-exception": { | ||
| "xgen-IPA-123-enum-values-must-be-upper-snake-case": "Schema predates IPA validation" | ||
| @@ -65263,7 +65266,8 @@ | ||
| "Kafka": "#/components/schemas/StreamsKafkaConnection", | ||
| "Sample": "#/components/schemas/StreamsSampleConnection", | ||
| "Https": "#/components/schemas/StreamsHttpsConnection", | ||
| - "AWSLambda": "#/components/schemas/StreamsAWSLambdaConnection" | ||
| + "AWSLambda": "#/components/schemas/StreamsAWSLambdaConnection", | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IPA-123: Enums - The enum values for the
typefield in the StreamsConnection schema are not inUPPER_SNAKE_CASE. This violates the guideline that enum values must be inUPPER_SNAKE_CASE.While there is an exception documented for this case, it's recommended to update these values to comply with the guideline in future versions.