Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
238478f
Copy files from stable/2023-05-01
jamezlim Sep 13, 2024
d9de423
Update version to preview/2024-10-01-preview
jamezlim Sep 13, 2024
7bc506b
Added tag for 2024-10-01-preview in readme file
jamezlim Sep 13, 2024
ab56599
added 2024-10-01-preview
jamezlim Sep 13, 2024
b1871c6
remove additionalProperties
jamezlim Sep 14, 2024
a330cd9
Merge branch 'main' into MicroJamesLim/containerinstances-2024-10-01-…
MicroJamesLim Sep 14, 2024
7b38efa
Merge branch 'main' into MicroJamesLim/containerinstances-2024-10-01-…
MicroJamesLim Sep 16, 2024
f4f701c
Merge remote-tracking branch 'upstream/main' into MicroJamesLim/conta…
jamezlim Sep 16, 2024
d6474c3
Merge branch 'MicroJamesLim/containerinstances-2024-10-01-preview' of…
jamezlim Sep 16, 2024
59799b7
Copy files from stable/2023-05-01
jamezlim Sep 13, 2024
f09a2d3
Update version to preview/2024-10-01-preview
jamezlim Sep 13, 2024
e786c7a
Added tag for 2024-10-01-preview in readme file
jamezlim Sep 13, 2024
f9bddd8
added 2024-10-01-preview
jamezlim Sep 13, 2024
f40381f
remove additionalProperties
jamezlim Sep 14, 2024
250d610
resolved PR comment
jamezlim Sep 18, 2024
605c91e
Merge branch 'MicroJamesLim/containerinstances-2024-10-01-preview' of…
jamezlim Sep 18, 2024
66cc743
update from secrets to secretReferences
jamezlim Sep 20, 2024
251baec
suppress additionalProperties
jamezlim Sep 20, 2024
0e0386c
delete file
jamezlim Sep 20, 2024
b8da33a
Merge branch 'main' into MicroJamesLim/containerinstances-2024-10-01-…
MicroJamesLim Sep 20, 2024
574b260
Merge branch 'main' into MicroJamesLim/containerinstances-2024-10-01-…
jamezlim Sep 20, 2024
2e412bb
Merge branch 'MicroJamesLim/containerinstances-2024-10-01-preview' of…
jamezlim Sep 20, 2024
3e4cf82
update to 'arm-id' format
jamezlim Sep 25, 2024
c0a4e26
Merge branch 'main' into MicroJamesLim/containerinstances-2024-10-01-…
MicroJamesLim Sep 26, 2024
923200c
Merge remote-tracking branch 'upstream/main' into MicroJamesLim/conta…
jamezlim Sep 26, 2024
27badf3
Merge branch 'MicroJamesLim/containerinstances-2024-10-01-preview' of…
jamezlim Sep 26, 2024
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
Prev Previous commit
Next Next commit
suppress additionalProperties
  • Loading branch information
jamezlim committed Sep 20, 2024
commit 251baec625cd94a63d03c9c0abc7abc5998f46e8
Original file line number Diff line number Diff line change
Expand Up @@ -1241,7 +1241,10 @@
},
"SecretReferenceVolume": {
Copy link
Member

Choose a reason for hiding this comment

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

SecretReferenceVolume

how is this property used?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is also a dictionary just as 'SecretVolume'. The 'SecretVolume' is a dictionary of customer provided explicit secret values whereas 'SecretReferenceVolume' is a customer provided secret reference value. The value will point to one of the 'SecretReference' object defined in line 839

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wanted to add the additional properties to indicate a dictionary object as stated here https://swagger.io/docs/specification/data-models/dictionaries/
but the PR was giving me Swagger LintDiff validation failures RPC-Policy-V1-05, RPC-Put-V1-23. Please advise

Copy link
Member

Choose a reason for hiding this comment

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

This is because ARM is trying to reduce instances of unschematized APIs to make it easier for consumers of those APIs to understand them and use them reliably

It is recommended to use arrays with pairs in place of dictionary if defining a schema is not possible.

If it is not possible provide an explanation for why you need this and obtain a suppresion for the Swagger LintDiff validation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the feedback. Suppressed.

"description": "The secret reference volume.",
"type": "object"
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"GitRepoVolume": {
"description": "Represents a volume that is populated with the contents of a git repository",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
suppressions:
- code: AvoidAdditionalProperties
from: swagger.yaml
reason: Keeping it for legacy tooling
6 changes: 6 additions & 0 deletions specification/containerinstance/resource-manager/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,12 @@ suppressions:
- containerInstance.json
where:
- $.definitions.ConfigMap.properties.keyValuePairs
- code: AvoidAdditionalProperties
reason: additional feature addition to existing secretVolumes which is defined as a dictionary
from:
- containerInstance.json
where:
- $.definitions.SecretReferenceVolume
```

---
Expand Down