Skip to content

Commit 145da44

Browse files
Spec fixed to reflect new examples property (#15377)
* Spec fixed to reflect new examples property * Prettier * suppressing incorrect warning
1 parent 61b2f3a commit 145da44

File tree

2 files changed

+50
-20
lines changed

2 files changed

+50
-20
lines changed

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/definitions.json

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3715,6 +3715,10 @@
37153715
"typeName": {
37163716
"type": "string",
37173717
"description": "Type name defined by the schema."
3718+
},
3719+
"examples": {
3720+
"$ref": "#/definitions/ParameterExamplesContract",
3721+
"description": "Exampled defined for the parameter."
37183722
}
37193723
},
37203724
"required": [
@@ -3723,6 +3727,33 @@
37233727
],
37243728
"description": "Operation parameters details."
37253729
},
3730+
"ParameterExamplesContract": {
3731+
"additionalProperties": {
3732+
"$ref": "#/definitions/ParameterExampleContract",
3733+
"description": "Parameter example."
3734+
},
3735+
"description": "Parameter examples."
3736+
},
3737+
"ParameterExampleContract": {
3738+
"description": "Parameter example.",
3739+
"properties": {
3740+
"summary": {
3741+
"type": "string",
3742+
"description": "Short description for the example"
3743+
},
3744+
"description": {
3745+
"type": "string",
3746+
"description": "Long description for the example"
3747+
},
3748+
"value": {
3749+
"description": "Example value. May be a primitive value, or an object."
3750+
},
3751+
"externalValue": {
3752+
"type": "string",
3753+
"description": "A URL that points to the literal example"
3754+
}
3755+
}
3756+
},
37263757
"PipelineDiagnosticSettings": {
37273758
"properties": {
37283759
"request": {
@@ -4687,10 +4718,6 @@
46874718
"type": "string",
46884719
"description": "Specifies a registered or custom content type for this representation, e.g. application/xml."
46894720
},
4690-
"sample": {
4691-
"type": "string",
4692-
"description": "An example of the representation."
4693-
},
46944721
"schemaId": {
46954722
"type": "string",
46964723
"description": "Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'."

specification/apimanagement/resource-manager/readme.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -523,7 +523,7 @@ See configuration in [readme.az.md](./readme.az.md)
523523
## Suppression
524524

525525
``` yaml
526-
directive:
526+
directive:
527527
- suppress: R4009
528528
from: apimapis.json
529529
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
@@ -559,53 +559,56 @@ directive:
559559
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
560560
- suppress: R4009
561561
from: apimnamedvalues.json
562-
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
562+
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
563563
- suppress: R4009
564564
from: apimgateways.json
565-
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
565+
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
566566
- suppress: R4009
567567
from: apimgroups.json
568-
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
568+
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
569569
- suppress: R4009
570570
from: apimcontenttypes.json
571571
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
572572
- suppress: R4009
573573
from: apimdeletedservices.json
574-
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
574+
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
575575
- suppress: R4009
576576
from: apimdiagnostics.json
577-
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
577+
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
578578
- suppress: R4009
579579
from: apimemailtemplates.json
580-
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
580+
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
581581
- suppress: R4009
582582
from: apimidentityprovider.json
583583
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
584584
- suppress: R4009
585585
from: apimissues.json
586-
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
586+
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
587587
- suppress: R4009
588588
from: apimloggers.json
589-
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
589+
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
590590
- suppress: R4009
591591
from: apimopenidconnectproviders.json
592-
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
592+
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
593593
- suppress: R4009
594594
from: apimpolicies.json
595-
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
595+
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
596596
- suppress: R4009
597597
from: apimportalrevisions.json
598598
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
599599
- suppress: R4009
600600
from: apimsettings.json
601-
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
601+
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
602602
- suppress: R4009
603603
from: apimtags.json
604-
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
604+
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
605605
- suppress: R4009
606606
from: apimtenant.json
607-
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
607+
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
608608
- suppress: R4009
609609
from: apimnotifications.json
610-
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
611-
```
610+
reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version.
611+
- suppress: R4037
612+
from: definitions.json
613+
reason: We want customers to be able to supply any valid JSON token, object or otherwise
614+
```

0 commit comments

Comments
 (0)