Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some issues in resource graph swaggers -- (related to https://github.com/Azure/azure-rest-api-specs/issues/9136) #9466

Closed
dolauli opened this issue May 15, 2020 · 6 comments
Assignees
Labels
Resource Graph Service Attention Workflow: This issue is responsible by Azure service team.

Comments

@dolauli
Copy link
Contributor

dolauli commented May 15, 2020

Part of the issues listed in #9136 have not been fixed though the ticket has been closed.
List the details as below.

  1. location can not be readonly in https://github.com/Azure/azure-rest-api-specs/blob/master/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/graphquery.json#L272.
  2. Following is the raw HTTP response when getting a specific query. Please see my comments start with //, which are issues not addressed.
{
  "properties": {
    "resultKind": "UnKnown",
    "timeModified": "2020-04-17T10:47:44.3813391Z",
    "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'dockers'"
  },
  "type": "microsoft.resourcegraph/queries",
  "location": "global",
  "subscriptionId": "9e223dbe-3399-4e19-88eb-0975f02ac87f", // subscriptionId is missing in the swagger
  "resourceGroup": "testgroup", // resourceGroup is missing in the swagger
  "name": "sq01",
  "id": "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup/providers/microsoft.resourcegraph/queries/sq01",
  "etag": "\"00003200-0000-1800-0000-5e9989500000\"" // it should be etag, but in swagger it is eTag. BTW, I think the value of "etag" should be "00003200-0000-1800-0000-5e9989500000"
} 
@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label May 15, 2020
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label May 15, 2020
@dolauli dolauli added the Service Attention Workflow: This issue is responsible by Azure service team. label May 15, 2020
@ghost
Copy link

ghost commented May 15, 2020

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @demyanenko.

@dolauli
Copy link
Contributor Author

dolauli commented Jun 5, 2020

Any updates on this issue?

@chiragg4u
Copy link
Contributor

Thanks @dolauli for reporting this issue. We are looking at planning this work.

@snaheth
Copy link
Contributor

snaheth commented Oct 1, 2020

Pending PR from @Yobretaw (attached from link above)

@Yobretaw
Copy link
Member

@dolauli I believe the 1st issue (location readonly) has been fixed. For your comments in the 2nd item, a SavedQuery is actually a tracked resource which by definition has no subscriptionId/resourceGroup. We are mistakenly returning them in the current GET calls, and we'll be dropping those two fields shortly so that the response payload and swagger definition will be matching.

I'll fixing the etag casing in swagger. Regarding to the format (should have no double quotes inside), since it is not relevant to the swagger I've created a task on our side and will track it separately since it's not relevant to swagger.

@snaheth
Copy link
Contributor

snaheth commented Aug 17, 2021

Closing this issue as @Yobretaw has addressed the issue above.

We are also rolling out an update soon to remove subscriptionId and resourceGroup from the response body for this endpoint. We're doing this because:

  1. It ensures that our swagger and response body matches 1:1
  2. Those two fields are implicit in the request ARM ID / Request URI

@snaheth snaheth closed this as completed Aug 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Resource Graph Service Attention Workflow: This issue is responsible by Azure service team.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants