Review of PostgreSQL swagger descriptions and examples#34864
Merged
nachoalonsoportillo merged 24 commits intoMay 27, 2025
Merged
Review of PostgreSQL swagger descriptions and examples#34864nachoalonsoportillo merged 24 commits into
nachoalonsoportillo merged 24 commits into
This check has been archived and is scheduled for deletion.
Learn more about checks retention
openapi-pipeline-app / Swagger LintDiff
succeeded
May 27, 2025 in 3m 51s
Swagger LintDiff succeeded
Details
| Compared specs (v2.2.3) | new version | base version |
|---|---|---|
| package-flexibleserver-2024-08-01 | package-flexibleserver-2024-08-01(01a0a6f) | package-flexibleserver-2024-08-01(main) |
| package-flexibleserver-2025-01-01-preview | package-flexibleserver-2025-01-01-preview(01a0a6f) | package-flexibleserver-2025-01-01-preview(main) |
The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Administrators.json#L38 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Administrators.json#L38 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Administrators_Create' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Administrators.json#L38 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Administrators.json#L38 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Administrators.json#L108 |
|
Model definition 'CapabilitiesListResult' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Capabilities.json#L626 |
|
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Configuration.json#L126 |
|
200 response schema in long running PATCH operation is missing ProvisioningState property. A LRO PATCH operations 200 response schema must have ProvisioningState specified. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Configuration.json#L164 |
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Configuration.json#L196 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Configuration.json#L196 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Configuration.json#L196 |
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Databases.json#L38 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Databases.json#L38 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Databases.json#L38 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Databases.json#L108 |
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FirewallRules.json#L38 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FirewallRules.json#L38 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FirewallRules.json#L38 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FirewallRules.json#L108 |
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json#L38 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json#L38 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json#L38 |
|
Properties of a PATCH request body must not have default value, property:backupRetentionDays. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json#L178 |
|
Properties of a PATCH request body must not have default value, property:geoRedundantBackup. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json#L178 |
|
Properties of a PATCH request body must not have default value, property:mode. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json#L178 |
|
Properties of a PATCH request body must not have default value, property:customWindow. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json#L178 |
|
Properties of a PATCH request body must not have default value, property:passwordAuth. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json#L178 |
|
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json#L178 |
|
Properties of a PATCH request body must not be required, property:tier. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json#L178 |
|
200 response schema in long running PATCH operation is missing ProvisioningState property. A LRO PATCH operations 200 response schema must have ProvisioningState specified. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json#L185 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json#L211 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json#L1040 |
|
Properties of a PATCH request body must not be required, property:adminCredentials. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Migrations.json#L203 |
|
Properties of a PATCH request body must not be required, property:sourceServerPassword. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Migrations.json#L203 |
|
Properties of a PATCH request body must not be required, property:targetServerPassword. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Migrations.json#L203 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Migrations.json#L921 |
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Operations.json#L58 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Operations.json#L132 |
|
Model definition 'OperationListResult' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Operations.json#L144 |
|
Model definition 'QuotaUsagesListResult' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/QuotaUsages.json#L124 |
|
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ServerStartStopRestart.json#L38 |
|
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ServerStartStopRestart.json#L100 |
|
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ServerStartStopRestart.json#L151 |
|
Model definition 'TuningOptionsListResult' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/TuningOptions.json#L703 |
|
Model definition 'VirtualEndpointsListResult' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/VirtualEndpoints.json#L372 |
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json#L38 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json#L38 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Administrators_Create' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json#L38 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json#L38 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json#L108 |
Loading