Skip to content

Commit

Permalink
Updating documentation (#3184)
Browse files Browse the repository at this point in the history
* Update openapi-authoring-automated-guidelines.md

* Update openapi-authoring-automated-guidelines.md

* Update openapi-authoring-automated-guidelines.md

* Update openapi-authoring-automated-guidelines.md

* Update openapi-authoring-automated-guidelines.md

* Update openapi-authoring-automated-guidelines.md

* Update openapi-authoring-automated-guidelines.md
  • Loading branch information
mozehgir authored and annatisch committed Jun 7, 2018
1 parent 709ef95 commit e02b768
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions documentation/openapi-authoring-automated-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,8 @@ The date MAY optionally be followed by one of:
Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings)

### <a name="R3014" />R3014 BodyPropertiesNamesCamelCase
Please refer to [R3016](#R3016)

### <a name="R3016" />R3016 DefinitionsPropertiesNamesCamelCase
**Category** : ARM Error

Expand Down Expand Up @@ -1247,6 +1249,20 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul
Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings)

### <a name="R2024" />R2024 AnonymousBodyParameter
**Category** : SDK Error

**Applies to** : ARM specs

**Output Message**: Inline/anonymous models must not be used, instead define a schema with a model name in the "definitions" section and refer to it. This allows operations to share the models.

**Description**: This rule appears if in the parameter definition you have anonymous types.

**Why the rule is important**: Anonymous parameters will be autogenerated as non-descriptive parameters which the client will not be able to share across operations or provide good documentation for, thereby resulting in poor user experience.

**How to fix the violation**: Move the schema to the definitions section and reference it using $ref.

Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings)

### <a name="R2026" />R2026 AvoidAnonymousTypes
**Category** : SDK Error

Expand Down

0 comments on commit e02b768

Please sign in to comment.