Skip to content

Latest commit

 

History

History
95 lines (61 loc) · 5.55 KB

changelog.md

File metadata and controls

95 lines (61 loc) · 5.55 KB

Changelog

What's New (02/19/2020)

New validation rules

  • A new rule.
  • A new rule.

What's New (02/18/2020)

New validation rules

  • OperationIdRequired rule - each operation must has a unique operationId.

Changed Rule

  • Changed the linter rule BodyTopLevelProperties -- support systemData top level property
  • Changed the linter rule PatchBodyParametersSchema -- allow required property which be marked as descrimintor

What's New (01/07/2020)

bug fix

  • when x-ms-path contains OData, it will fail the SwaggerParser.Parse. fix this bug, and add a test to it.

What's New (10/05/2018)

New validation rules

  • LongRunningOperationsOptionsValidator rule - The rule will check if a post LRO operation has "x-ms-long-running-operation-options" extension enabled. Refer Issue #172, PR #179 and PR #4039 for further details.

What's New (05/09/2018)

New validation rules

  • PageableOperation rule - The rule will check if a get operation returns a schema (with 3 or less properties) with an array property. If it is so, the linter will suggest the operation might be pagebale. Refer PR #161 for further details.

What's New (05/02/2018)

Changed Category

  • Removed the Category RPCViolation and renamed it to ARMViolation in both dotnet and typescript linters.

What's New (04/26/2018)

Changed Rule

  • Changed the linter rule XmsExamplesRequired -- it now has a Category of Documentation and an id of D5001. Refer Issue #189 for further details.

What's New (03/14/2018)

Resolved issues/Bug fixes

  • Fixed Typo in AllowedTopLevelProperties list in BodyTopLevelProperties rule.Refer Issue #144 and PR #146 for further details.

New validation rules

  • XmsParameterLocation - Any global parameter (other than subscription Id and API Version) must have the "x-ms-parameter-location" extension applied. If the parameter should be a client parameter, then the extension must have the value "client". Else, it must have the have "method". Refer Issue #84 and PR #2649 for further details.

What's New (11/28/2017)

Resolved issues/Bug fixes

  • Fixed camel case suggestions, lowercasing the first character.
  • Both dotnet and typescript sections can be debugged again.
  • Fixed errors in the application of NotNodeName rule.

What's New (11/08/2017)

Resolved issues/Bug fixes

  • Correcting path retruned by PostOperationIdContainsUrlVerb rule
  • Added zones as allowed top level properties

What's New (09/12/2017)

Resolved issues/Bug fixes

  • Better camelcased suggestions
  • Better handling of empty operationIds in OpenAPI specs
  • Case insensitive checks for top level resource properties
  • Better messaging for tracked resources related rules

New validation rules

  • ArraySchemaMustHaveItems – A schema of array type must always contain an items property. without it, AutoRest will fail to generate an SDK. Documentation link Category: SDK Error
  • LicenseHeaderMustNotBeSpecified - x-ms-code-generation-settings must not have the license section specified in the OpenAPI documents since each generated SDK can have a different licensing header. This information must be provided either from the command line or the configuration file when actually generating the sdk. Documentation link Category : SDK Warning
  • PostOperationIdContainsUrlVerb - A POST operation's operationId should contain the verb indicated at the end of the corresponding url. Documentation link Category : SDK Warning

What's New (07/07/2017)

Resolved issues/Bug fixes

  • Ensure Top level properties cannot be outside a fixed set. Linked issue

  • Add Message about tenant level resources to ListByResourceGroup and ListBySubcription. Linked issue

  • Ensuring validating items property must exist for an array type.

  • Better path reporting for R3010. Linked issue

  • Filtering resource models returned only by post. Linked issue

  • Adding rule categorizations (Merge state and document type) to validation rules. Linked issue

New validation rules

  • New validation rule for Post operationIds. Documentation link
  • Validation rule for verifying license headers. Documentation link