Azure / Azure/azure-rest-api-specs

Microsoft.AppPlatform/Spring/apps@2022-09-01-preview - ROUNDTRIP_INCONSISTENT_PROPERTY

Open
#21,536 0 comments 0 reactions 0 assignees View on GitHub
AppPlatform Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

## Microsoft.AppPlatform/Spring/apps@2022-09-01-preview - ROUNDTRIP_INCONSISTENT_PROPERTY

### Description

I found differences between PUT request body and GET response:

- .properties.ingressSettings.backendProtocol: expect GRPC, but got Default
- .properties.ingressSettings.readTimeoutInSeconds: expect 101, but got 300
- .properties.ingressSettings.sendTimeoutInSeconds: expect 101, but got 60
- .properties.ingressSettings.sessionCookieMaxAge: expect 300, but got 0

```json
{
"properties": {
"ingressSettings": {
"backendProtocol": Got "Default" in response, expect "GRPC",
"readTimeoutInSeconds": Got 300 in response, expect 101,
"sendTimeoutInSeconds": Got 60 in response, expect 101,
"sessionAffinity": "None",
"sessionCookieMaxAge": Got 0 in response, expect 300
}
}
}
```

### Details

1. ARM Fully-Qualified Resource Type
```
Microsoft.AppPlatform/Spring/apps
```

2. API Version
```
2022-09-01-preview
```

3. Swagger issue type
```
Swagger Correctness
```

4. OperationId
```
TODO
e.g., VirtualMachines_Get
```

5. Swagger GitHub permalink
```
TODO,
e.g., https://github.com/Azure/azure-rest-api-specs/blob/60723d13309c8f8060d020a7f3dd9d6e380f0bbd
/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json#L9065-L9101
```

6. Error code
```
ROUNDTRIP_INCONSISTENT_PROPERTY
```

7. Request traces
```
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/henglu1114-spring-ingress/providers/Microsoft.AppPlatform/Spring/henglu1114ingress/apps/henglu1114ingress1?api-version=2022-09-01-preview
Accept: application/json
Authorization: REDACTED
Content-Length: 166
Content-Type: application/json
User-Agent: HashiCorp Terraform/1.2.8 (+https://www.terraform.io) Terraform Plugin SDK/2.8.0 terraform-provider-azapi/dev pid-222c6c49-1b0a-5959-a213-6608f9eb8820
X-Ms-Correlation-Request-Id: REDACTED
--------------------------------------------------------------------------------
{"properties":{"ingressSettings":{"backendProtocol":"GRPC","readTimeoutInSeconds":101,"sendTimeoutInSeconds":101,"sessionAffinity":"None","sessionCookieMaxAge":300}}}
--------------------------------------------------------------------------------

RESPONSE Status: 201 Created
Azure-Asyncoperation: REDACTED
Cache-Control: no-cache
Content-Length: 899
Content-Type: application/json; charset=utf-8
Date: Mon, 14 Nov 2022 05:15:28 GMT
Expires: -1
Location: REDACTED
Pragma: no-cache
Request-Context: REDACTED
Strict-Transport-Security: REDACTED
X-Content-Type-Options: REDACTED
X-Ms-Client-Request-Id: 33995ba3-f98a-4247-8938-f1fe81804110
X-Ms-Correlation-Request-Id: REDACTED
X-Ms-Ratelimit-Remaining-Subscription-Resource-Requests: REDACTED
X-Ms-Request-Id: 6ccf35ae-6be9-4cda-99e1-96eadb3af101
X-Ms-Routing-Request-Id: REDACTED
X-Rp-Server-Mvid: REDACTED
--------------------------------------------------------------------------------
{"properties":{"addonConfigs":{"applicationConfigurationService":{},"serviceRegistry":{}},"public":false,"provisioningState":"Creating","httpsOnly":false,"enableEndToEndTLS":false,"ingressSettings":{"readTimeoutInSeconds":101,"sendTimeoutInSeconds":101,"sessionCookieMaxAge":0,"sessionAffinity":"None","backendProtocol":"GRPC"}},"type":"Microsoft.AppPlatform/Spring/apps","identity":null,"location":"westeurope","id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/henglu1114-spring-ingress/providers/Microsoft.AppPlatform/Spring/henglu1114ingress/apps/henglu1114ingress1","name":"henglu1114ingress1","systemData":{"createdBy":"0ddf9866-48e9-4e1d-a880-17a2ea0c9ec6","createdByType":"Application","createdAt":"2022-11-14T05:15:27.9524184Z","lastModifiedBy":"0ddf9866-48e9-4e1d-a880-17a2ea0c9ec6","lastModifiedByType":"Application","lastModifiedAt":"2022-11-14T05:15:27.9524184Z"}}
--------------------------------------------------------------------------------

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/henglu1114-spring-ingress/providers/Microsoft.AppPlatform/Spring/henglu1114ingress/apps/henglu1114ingress1?api-version=2022-09-01-preview
Accept: application/json
Authorization: REDACTED
User-Agent: HashiCorp Terraform/1.2.8 (+https://www.terraform.io) Terraform Plugin SDK/2.8.0 terraform-provider-azapi/dev pid-222c6c49-1b0a-5959-a213-6608f9eb8820
X-Ms-Correlation-Request-Id: REDACTED
--------------------------------------------------------------------------------
RESPONSE Status: 200 OK
Cache-Control: no-cache
Content-Type: application/json; charset=utf-8
Date: Mon, 14 Nov 2022 05:16:00 GMT
Expires: -1
Pragma: no-cache
Request-Context: REDACTED
Strict-Transport-Security: REDACTED
Vary: REDACTED
X-Content-Type-Options: REDACTED
X-Ms-Client-Request-Id: 00272cf2-87ed-47cf-b006-ea4c1e5787a7
X-Ms-Correlation-Request-Id: REDACTED
X-Ms-Ratelimit-Remaining-Subscription-Resource-Requests: REDACTED
X-Ms-Request-Id: 96b02996-e915-4626-8dd0-23ec3ba4b08f
X-Ms-Routing-Request-Id: REDACTED
X-Rp-Server-Mvid: REDACTED
--------------------------------------------------------------------------------
{"properties":{"addonConfigs":{"applicationConfigurationService":{},"serviceRegistry":{}},"public":false,"provisioningState":"Succeeded","fqdn":"henglu1114ingress.azuremicroservices.io","httpsOnly":false,"temporaryDisk":{"sizeInGB":5,"mountPath":"/tmp"},"persistentDisk":{"sizeInGB":0,"mountPath":"/persistent"},"enableEndToEndTLS":false,"ingressSettings":{"readTimeoutInSeconds":300,"sendTimeoutInSeconds":60,"sessionCookieMaxAge":0,"sessionAffinity":"None","backendProtocol":"Default"}},"type":"Microsoft.AppPlatform/Spring/apps","identity":null,"location":"westeurope","id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/henglu1114-spring-ingress/providers/Microsoft.AppPlatform/Spring/henglu1114ingress/apps/henglu1114ingress1","name":"henglu1114ingress1","systemData":{"createdBy":"0ddf9866-48e9-4e1d-a880-17a2ea0c9ec6","createdByType":"Application","createdAt":"2022-11-14T05:15:27.9524184Z","lastModifiedBy":"0ddf9866-48e9-4e1d-a880-17a2ea0c9ec6","lastModifiedByType":"Application","lastModifiedAt":"2022-11-14T05:15:27.9524184Z"}}
--------------------------------------------------------------------------------
```

### Links
1. [Semantic and Model Violations Reference](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/Semantic-and-Model-Violations-Reference.md)
2. [S360 action item generator for Swagger issues](https://aka.ms/swaggers360)

Contributor guide

Open the contributing guide

Research direction

Start with the Semantic and Model Violations Reference and locate the Microsoft.AppPlatform/Spring/apps definition for API version 2022-09-01-preview; the issue does not provide a Swagger permalink or operation ID. Compare the documented round-trip behavior with the supplied PUT and GET traces, and consider the issue done when the four ingressSettings values remain consistent between requests and responses.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.