Add specification

Author: xvw

ocaml-lsp-server/docs/ocamllsp/jumpTypedHoles-spec.md

@@ -0,0 +1,58 @@
+# Jump To Typed Holes Requet
+
+### Description
+
+Provides control over navigation between the different types of holes
+present in a document (allowing you to return the position of the next
+or previous hole) and to observe holes in ranges.
+
+
+### Why this custom request needed
+
+Reduces the need for editor-side logic and works well with the
+expression construct command. For example, constructing a value of
+type `int option` constructs, for example, the following expression:
+`Some _`, coupled with typed hole navigation, you can move the cursor
+directly over the generated hole.
+
+
+### A note on stability: 
+
+> OCaml-LSP does not guarantee stability for this custom request,
+> meaning the core contributors may change or remove this custom
+> request, as they see necessary.
+
+## Client capability
+
+nothing that should be noted
+
+## Server capability
+
+- property name: `handleJumpTypedHole`
+- property type: `boolean`
+
+## Request
+
+- method: `ocamllsp/jumpTypedHole`
+- params:
+
+```json
+{
+  "uri": TextDocumentIdentifier,
+  "position": Position,
+  "direction": <"next"|"prev">,
+  "range?": Range
+}
+```
+
+If a `range` is given, it will only select holes present in the given
+range.
+
+## Response
+
+```json
+Range | null
+```
+
+Returns the next or previous hole, or `null` if no hole has been
+found.