Changes in v3.1.0

Released Sep 24, 2020.

JS asset

JVM asset

Improved error recovery

In last ALS 3.0.2 release , a new SYAML version was included through AMF 4.3.0. This YAML parser release improved the completeness of a document process without aborting if a critical YAML error is found. Since ALS works in the edition tooling ecosystem this has always been critical for allowing editors to provide a consistent experience to developers working on a spec.
In this new ALS release we natively adopted these new features for YAML, removing code that was handling this error recovery logic at AML Language Server layer.

Actions

ALS improves in this release the supported actions set by including Hover, File rename and element extraction to declaration.

AMF 4.3.1 is also included in the release.

Stories:

• ALS-1105 - Rename file action
• ALS-1006 - Extract element to declaration
• ALS-1168 - Adopt syaml recovery changes in als
• ALS-1196 - Adopt non-patch content in OAS2 tests set
• ALS-1197 - Adopt non-patch content in OAS3 tests set
• ALS-1204 - Adopt non-patch content in RAML 1.0 tests set
• ALS-1205 - Adopt non-patch content in RAML 0.8 tests set
• ALS-1206 - Adopt non-patch content in AsyncAPI 2.0 tests set
• ALS-1207 - Adopt non-patch content in AML tests set

Bugs:

• ALS-1140 - Suggestion fails in empty file (one curly bracket only)
• ALS-1158 - Wrong suggestions on some OAS definitions with $ref
• ALS-1176 - The autocompletion has some incorrect behaviours
• ALS-1188 - Document highlight response is empty in elements with include clauses
• ALS-1190 - The break declaration [] is not working for "allowedTargets" node
• ALS-1203 - Header suggestions in empty file has a wrong label
• ALS-1212 - protocols options not listed for protocols node in a trait definition
• ALS-1171 - [SYAML] - fix recovery for empty yaml doc with header
• ALS-1172 - [SYAML] Fix last line with indentation error
• ALS-1173 - [SYAML] Fix string-dates invalid error
• ALS-1185 - [SYAML] Fix error over flow tokens at quoted string
• ALS-1191 - [SYAML] Error parsing valid document that ends with '\r'
• ALS-1192 - [SYAML] Error in map key after valid sequence at same indentation.

Changes in v3.0.2

Released Aug 28, 2020.

JS asset

JVM asset

This release contains improvements over Rename and Hover features the new version of AMF (4.3.0):

AMF 4.30: Comes with major version of SYAML 1.0.282 with recovery logic improved

Stories:

• ALS-1223 - Check ALS policy violatons
• ALS-1236 - Update requested terms declarations keys for hover

Enhancement Request:

• ALS-1210 - Enable Rename requests for types without references
• ALS-1228 - Rename not enabled for RAML library import

Bugs:

• ALS-1108 - Navigation to external reference does not select the referenced element
• ALS-1118 - Wrong goto definition at recursive declared schema
• ALS-1187 - Hover response has wrong range in elements with include clauses
• ALS-1193 - The go to links are marked in different positions
• ALS-1202 - Call Stack Size Exceeded error on Schema & Example for a resource
• ALS-1211 - Hover descriptions do not contain helpful information for Api Designer users
• ALS-1217 - Hover on declaration key results in whole document hover
• ALS-1218 - Rename action not working on raml type expression declaration
• ALS-1225 - Renaming an array property on a RAML definition removes the array
• ALS-1232 - rename not working for type defined in fragment and used in array definition

SYAML 1.0.282 impacts on ALS in case of a syntactic error:

Whereas before, in case of a syntax error it would mark the rest of the document invalid and ALS could provide no functionality on this segment, now the invalid part is reduced to the node, and ALS is able to provide functionality on the rest of the document.

• Diagnostics: in case of an invalid document there could be more Diagnostics (the document continues to validate even after a syntactic error, more info on this in AMF)
• Document Symbol: the model after SYAML recovery is now shown
• Folding Ranges/Document Highlighting/Selection Range: is now available after a syntactic error
• Document Links, "Go To", "Find" and Rename actions are now aware of the recovered part of the document

Changes in v3.0.1-1

Released Aug12, 2020.

JS asset

JVM asset

This is a HF to adopt AMF HF4.2.0-0:

Changes in v3.0.1-0

Released Aug 5, 2020.

JS asset

JVM asset

This is a HF for fix two critical issues:

Bugs:

• ALS-1215 - Cannot read property annotation$1 of null error when requesting PrepareRenameRequest in JS
• ALS-1216 - FilesInProjectEventNotifications stop being sent when having a spec with an empty array in securedBy node

Changes in v3.0.1

Released July 31, 2020.

JS asset

JVM asset

This release contains the new version of AMF (4.2.0) and some bug fixes

Story

• ALS-1164 - Resolve references for resource types and traits
• ALS-1143 - Analyze RAML type expressions navigation and renaming
• ALS-1117 - Standardize what includes the selection ranges of structure items
• ALS-953 - Oas 3.0 and OAs 2.0 apis for jvm-client test
• ALS-1165 - Check AMF tests results to evaluate impact of SYAML recovery

Bugs

• ALS-1208 - WorkspaceEdits response to RenameRequest does not match LSP typings in JS
• ALS-965 - Security scheme resolved on structure
• ALS-1025 - Handle didOpen after didClose
• ALS-1145 - Resource loader is sometimes ignored when parsing
• ALS-1146 - Go to implementation/type definition not working when including external files
• ALS-1150 - Navigation to types declarations does not work in "resourceTypes" and “traits” nodes
• ALS-1152 - Suggestions list does not include $ref in some cases
• ALS-1153 - Navigation to “resourceTypes", “traits" and “securitySchemes” declarations in RAML Libraries does not work
• ALS-1154 - Navigation to “resourceTypes” and “traits” with parameters, “securitySchemes” and “annotationTypes” declarations does not work
• ALS-1155 - Navigation to “schemas" declaration in RAML 0.8 does not work
• ALS-1162 - The break declaration [] is not working
• ALS-1167 - OAS3: "default" option is missing and <> options are incorrect
• ALS-1184 - oas3: suggestions include incorrect option [1-5]xx instead of [1-5]XX
• ALS-1188 - Document highlight response is empty in elements with include clauses

Changes in v3.0.0

Released Jul 3, 2020.

JS asset

JVM asset

This is a mayor version with breaking Changes.

This version comes with new LSP 3.15, adopt AMF 4.1.3 and a new set of "EyeCandy" actions.

Breaking changes:

• Move from language server protocol version 3.14 to 3.15.
• JVM: move from lsp4j 0.7.2 to lsp4j 0.9: https://github.com/eclipse/lsp4j/releases/tag/v0.9.0
• JS: move from "vscode-languageserver-protocol" 3.14.1 to 3.15.3 and "vscode-jsonrpc" 4.0.0 to 5.0.1
• Parameters for the following requests have been changed from TextDocumentPositionParams:
  textDocument/declaration changed to DeclarationParams
  textDocument/definition changed to DefinitionParams
  textDocument/typeDefinition changed to TypeDefinitionParams
  textDocument/implementation changed to ImplementationParams
• JVM: The LSP's Protocol Diagnostic field code was previouslyt incorrectly declared as String, it is now correctly declared as Either<String, Number>
• Telemetry: MessageTypes field changed from Integer to string.

Features

EyeCandy:

• ALS-993 - Implement Hover action
• ALS-998 - Implement find file usage
• ALS-999 - Implement document highlight
• ALS-1000 - Implement renaming
• ALS-1001 - Implement folding range
• ALS-1002 - Implement selection range
• ALS-1063 - Support indentation configuration for styling suggestions

LSP 3.15:

• ALS-1124 - Analyze moving Lsp4j 0.9.0
• ALS-1125 - Analyze vscode-languageserver library for LSP 3.15
• ALS-1126 - Adop lsp4j 0.9 in als-client
• ALS-1127 - Adopt lsp4j 0.9

Stories:

• ALS-1050 - Create internal dialect registry and consume it from plugins
• ALS-1136 - Add "xx" status code suggestions
• ALS-1156 - Analyze als-client performance deltas
• ALS-1133 - Telemetry enhancements | Message types and synchronized Begin/End messages

Bugs:

• ALS-1130 - Validations missing in JSON file referenced in root
• ALS-1132 - Class cast exception when specifying ClientLogger to LanguageServer in JS
• ALS-1135 - Change category for oas 3.0 types facets
• ALS-1137 - Suggestions not honoring the root file location
• ALS-1138 - Upper level folder suggestions not working
• ALS-1139 - Suggestions does not include application/xml in OAS 3 spec
• ALS-1140 - Suggestion fails in empty file (one curly bracket only)
• ALS-1141 - Incorrect suggestion for the context
• ALS-1144 - Indentation fails for selected suggestion (json)
• ALS-1151 - Suggestions do not provide any option when defining schema example
• ALS-1160 - Missing validation errors when including RAML fragments in a RAML 0.8

Changes in v2.4.1-0

Released Jun 11, 2020.

JS asset

JVM asset

This is a HF for fix two critical issue and adopt AMF HF 4.1.2-0:

Bugs:

• ALS-1134 - Oas 3.0 status codes suggestions should be quoted

Changes in v2.4.1

Released June 5, 2020.

JS asset

JVM asset

This release contains the new version of AMF (4.1.2) and Navigation support:

• Go to Definition
• Go to Implementation
• Go to Type Definition
• Find References

Story

• ALS-1128 - Errors are not reported on specific case in the root file
• ALS-1116 - Error when sending encoded uri in CleanDiagnostic request
• ALS-1101 - Underline for $ref links are shown on different places in OAS (json or yaml)
• ALS-1067 - OAS Spec: HTTP Status Codes are not suggested when declared with quotes
• ALS-1066 - OAS Spec: Improved when defines the enum values
• ALS-997 - Implement Find references action
• ALS-996 - Implement Go to implementation
• ALS-995 - Implement Go to Type definition
• ALS-994 - Implement Go to declaration action

Changes in v2.4.0-0

Released Jun 1, 2020.

JS asset

JVM asset

This is a HF for fix two critical issues:

Bugs:

• ALS-1119 - Stackoverflow when request completion over RecursiveShape
• ALS-1120 - CleanDiagnosticTree request does not return RecursiveShape error

Changes in v2.4.0

Released May 22, 2020.

JS asset

JVM asset

This release contains AsyncApi 2.0 support based on AMF beta support:

Story

• ALS-961 - Support RamlTypes definitions at AsyncApi 2.0
• ALS-962 - Full AsyncApi 2.0 suggestions test by node
• ALS-970 - Suggest payload properties of message object based on schema format
• ALS-971 - Binding suggestions based on key.
• ALS-972 - Suggest server security requirement reference
• ALS-973 - Suggest traits references in messages and operations
• ALS-974 - Runtime Expressions suggestions
• ALS-975 - Async api 2.0 Schema Object suggestions
• ALS-976 - Open api 3.0.0 schema object suggestion from async api
• ALS-977 - Json Schema Draft 7 support
• ALS-978 - Avro 1.9.0 schema suggestion support
• ALS-979 - Support oneOf at messages
• ALS-980 - Message headers suggestions
• ALS-981 - Async api 2.0 check and analize structure
• ALS-1068 - Re-check structure for OAS 3
• ALS-1074 - Title and version outline fields at AsyncApi 2.0
• ALS-1075 - Group declaration by meta name
• ALS-1076 - Improve payload object at messages
• ALS-1077 - Show async api object schema property names
• ALS-1078 - Show lincense and contact as root items at async api structure
• ALS-1079 - AsyncApi 2.0 servers structure improvements
• ALS-1080 - Improve async api 2.0 declared parameter outline
• ALS-1081 - Show async api 2.0 bindings structure
• ALS-1082 - Support async api 2.0 channels structure
• ALS-1090 - Structure - OAS 3 improvements
• ALS-1098 - Callbacks in an operation
• ALS-1099 - Links in responses
• ALS-1103 - Support async api 2.0 channel messages in structure
• ALS-1106 - Move Raml 1.0/08 and Oas 2.0/3.0 dialects to ALS
• ALS-1048 - Check behaviour of AsyncApi 2.0 suggestions at VS code (QA)
• ALS-1045 - OAS 2 JSON - Suggestion object does not have a comma in the template

Bug

• ALS-1021 - AML Completion | Boolean properties are not being suggested properly
• ALS-1041 - When creating a response example, datatype property suggestion gets disabled when nested inside
• ALS-1044 - After a Parametrized SecurityScheme name, suggestions returns the SecurityScheme name again
• ALS-1046 - OAS 2 JSON - Nodes already present on the same level are suggested
• ALS-1051 - AsyncAPI 2 | Root facets
• ALS-1052 - AsyncAPI 2 | Message $ref suggests "messageTraits" path
• ALS-1053 - AsyncAPI 2 | nested SchemaFormat not suggesting properly
• ALS-1054 - Json Schema | required properties not suggesting
• ALS-1055 - AsyncAPI 2 | Headers facets not showing $ref
• ALS-1056 - AsyncAPI 2 | defaultContentType not suggested
• ALS-1065 - Files with extensions .md, .xml and .xsd are not suggested
• ALS-1084 - FilesInProjectEventNotification send empty list for isolated files