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.

Sign up for GitHub

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

[Hub Generated] Review request for Microsoft.InstanceMetadataService to add version stable/2021-02-01 #14257

Merged
merged 8 commits into from
Jun 2, 2021
Merged

[Hub Generated] Review request for Microsoft.InstanceMetadataService to add version stable/2021-02-01 #14257

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
992c512
Adds base for updating Microsoft.InstanceMetadataService from version…
joshdmcc May 5, 2021
2e1c9bb
Updates readme
joshdmcc May 5, 2021
82cc10a
Updates API version in new specs and examples
joshdmcc May 5, 2021
e73e256
Adding swagger for imds version 2021-02-01
May 5, 2021
eab66a8
Adding new blob
May 6, 2021
7fc1c11
Fixing
May 6, 2021
727efc7
Spacing
May 26, 2021
a9d57c4
Prettier
May 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...a-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetAttestedData.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"parameters": {
"api-version": "2021-01-01",
"api-version": "2021-02-01",
"nonce": "abcde12345",
"Metadata": "true"
},
Expand Down
2 changes: 1 addition & 1 deletion ...a-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetIdentityInfo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"parameters": {
"api-version": "2021-01-01",
"api-version": "2021-02-01",
"Metadata": "true"
},
"responses": {
Expand Down
2 changes: 1 addition & 1 deletion ...-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetIdentityToken.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"parameters": {
"api-version": "2021-01-01",
"api-version": "2021-02-01",
"Metadata": "true",
"resource": "https://vault.azure.net"
},
Expand Down
5 changes: 4 additions & 1 deletion ...ane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetInstanceMetadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"parameters": {
"api-version": "2021-01-01",
"api-version": "2021-02-01",
"Metadata": "true"
},
"responses": {
Expand Down Expand Up @@ -99,6 +99,9 @@
"uri": ""
},
"writeAcceleratorEnabled": "false"
},
"resourceDisk": {
"size": "4096"
}
},
"subscriptionId": "8d10da13-8125-4ba9-a717-bf7490507b3d",
Expand Down
12 changes: 11 additions & 1 deletion specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/imds.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "InstanceMetadataClient",
"description": "The Azure Instance Metadata Client",
"version": "2021-01-01"
"version": "2021-02-01"
},
"host": "169.254.169.254",
"basePath": "/metadata",
Expand Down Expand Up @@ -578,6 +578,16 @@
"description": "This contains information about the data disk.",
"$ref": "#/definitions/DataDisk"
}
},
"resourceDisk": {
"type": "object",
"description": "This contains data for the size of local temp disk of the VM, if it exists.",
"properties": {
"size": {
"type": "string",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why isn't this an integer?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We return all numbers as strings representations.

"description": "The size of the local temp disk of the VM if it exists, in kilobytes. If the VM has no local temp disk, this value is 0."
}
}
}
}
},
Expand Down
31 changes: 27 additions & 4 deletions specification/imds/data-plane/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ These are the global settings for the Instance Metadata Service API.
``` yaml
openapi-type: data-plane
azure-arm: false
tag: package-2021-01-01
tag: package-2021-02-01
```

### Tag: package-2018-10-01
Expand Down Expand Up @@ -165,6 +165,15 @@ input-file:
- Microsoft.InstanceMetadataService/stable/2021-01-01/imds.json
```

### Tag: package-2021-02-01

These settings apply only when `--tag=package-2021-02-01` is specified on the command line.

``` yaml $(tag) == 'package-2021-02-01'
input-file:
- Microsoft.InstanceMetadataService/stable/2021-02-01/imds.json
```

## Suppression

``` yaml
Expand Down Expand Up @@ -414,8 +423,23 @@ directive:
- $.definitions.IdentityTokenResponse.properties.object_id
- $.definitions.IdentityTokenResponse.properties.msi_res_id
- $.definitions.IdentityErrorResponse.properties.error_description
```

- suppress: DefinitionsPropertiesNamesCamelCase
reason: The following properties follow the Oath2 spec, which does not use camelCase.
from: Microsoft.InstanceMetadataService/stable/2021-02-01/imds.json
where:
- $.definitions.IdentityTokenResponse.properties.access_token
- $.definitions.IdentityTokenResponse.properties.expires_in
- $.definitions.IdentityTokenResponse.properties.expires_on
- $.definitions.IdentityTokenResponse.properties.ext_expires_in
- $.definitions.IdentityTokenResponse.properties.not_before
- $.definitions.IdentityTokenResponse.properties.resource
- $.definitions.IdentityTokenResponse.properties.token_type
- $.definitions.IdentityTokenResponse.properties.client_id
- $.definitions.IdentityTokenResponse.properties.object_id
- $.definitions.IdentityTokenResponse.properties.msi_res_id
- $.definitions.IdentityErrorResponse.properties.error_description
```

---

Expand Down Expand Up @@ -477,8 +501,7 @@ input-file:
- $(this-folder)/Microsoft.InstanceMetadataService/stable/2020-10-01/imds.json
- $(this-folder)/Microsoft.InstanceMetadataService/stable/2020-12-01/imds.json
- $(this-folder)/Microsoft.InstanceMetadataService/stable/2021-01-01/imds.json


- $(this-folder)/Microsoft.InstanceMetadataService/stable/2021-02-01/imds.json

```

Expand Down