examples: add some executable examples (hurl)

Author: Pfeil

documentation/examples/create-and-resolve-pid.hurl

@@ -0,0 +1,30 @@
+# create/register a pid record
+POST http://localhost:8090/api/v1/pit/pid/
+Content-Type: application/vnd.datamanager.pid.simple+json
+Accept: application/vnd.datamanager.pid.simple+json
+{
+    "record": [
+        { "key": "21.T11148/076759916209e5d62bd5", "value": "21.T11148/301c6f04763a16f0f72a" },
+        { "key": "21.T11148/397d831aa3a9d18eb52c", "value": "2021-12-21T17:36:09.541+00:00" },
+        { "key": "21.T11148/8074aed799118ac263ad", "value": "21.T11148/37d0f4689c6ea3301787" },
+        { "key": "21.T11148/92e200311a56800b3e47", "value": "{ \"sha256sum\": \"sha256 c50624fd5ddd2b9652b72e2d2eabcb31a54b777718ab6fb7e44b582c20239a7c\" }" },
+        { "key": "21.T11148/aafd5fb4c7222e2d950a", "value": "2021-12-21T17:36:09.541+00:00" },
+        { "key": "21.T11148/b8457812905b83046284", "value": "https://test.repo/file001" },
+        { "key": "21.T11148/c692273deb2772da307f", "value": "1.0.0" },
+        { "key": "21.T11148/c83481d4bf467110e7c9", "value": "21.T11148/ManuscriptPage" }
+    ]
+}
+
+# on success, we get a 201
+HTTP 201
+# in the response body, you'll get the record and the pid
+[Captures]
+pid: jsonpath "$.pid"
+
+# if we resolve the pid...
+GET http://localhost:8090/api/v1/pit/pid/{{pid}}
+
+# we get exactly the same body on success
+HTTP 200
+[Asserts]
+jsonpath "$.pid" == {{pid}}

documentation/examples/query-elasticsearch.hurl

@@ -0,0 +1,11 @@
+POST http://localhost:8090/api/v1/search?page=0&size=20
+accept: application/hal+json
+Content-Type: application/json
+{
+  "query": {
+    "exists" : {
+      "field" : "pid"
+    }
+  },
+  "_source": ["pid"]
+}

documentation/examples/validate-existing-pid.hurl

@@ -0,0 +1,34 @@
+# Create/register a pid record.
+# As we use the Typed PID Maker, it must be valid, otherwise it will not work.
+POST http://localhost:8090/api/v1/pit/pid/
+Content-Type: application/vnd.datamanager.pid.simple+json
+Accept: application/vnd.datamanager.pid.simple+json
+{
+    "record": [
+        { "key": "21.T11148/076759916209e5d62bd5", "value": "21.T11148/301c6f04763a16f0f72a" },
+        { "key": "21.T11148/397d831aa3a9d18eb52c", "value": "2021-12-21T17:36:09.541+00:00" },
+        { "key": "21.T11148/8074aed799118ac263ad", "value": "21.T11148/37d0f4689c6ea3301787" },
+        { "key": "21.T11148/92e200311a56800b3e47", "value": "{ \"sha256sum\": \"sha256 c50624fd5ddd2b9652b72e2d2eabcb31a54b777718ab6fb7e44b582c20239a7c\" }" },
+        { "key": "21.T11148/aafd5fb4c7222e2d950a", "value": "2021-12-21T17:36:09.541+00:00" },
+        { "key": "21.T11148/b8457812905b83046284", "value": "https://test.repo/file001" },
+        { "key": "21.T11148/c692273deb2772da307f", "value": "1.0.0" },
+        { "key": "21.T11148/c83481d4bf467110e7c9", "value": "21.T11148/ManuscriptPage" }
+    ]
+}
+
+# on success, we get a 201
+HTTP 201
+# in the response body, you'll get the record and the pid
+[Captures]
+pid: jsonpath "$.pid"
+
+# if we resolve the pid...
+GET http://localhost:8090/api/v1/pit/pid/{{pid}}?validation=true
+Accept: application/vnd.datamanager.pid.simple+json
+
+# on validation fail, we get 400 instead of 200
+# unfortunately we can (by default) not create invalid PIDs using the Typed PID Maker,
+# so we can not properly demonstrate it here, as long as it is in sandboxed mode.
+# This limitation is being worked on (current version at the time of writing is 2.0.0):
+# In future we plan to allow resolving all kinds of real PIDs even in sandboxed mode.
+HTTP 200

documentation/examples/validate-record-without-registration.hurl

@@ -0,0 +1,29 @@
+# Sending a pid record with dryrun parameter will skip registration,
+# but still include the validation!
+POST http://localhost:8090/api/v1/pit/pid/?dryrun=true
+Content-Type: application/vnd.datamanager.pid.simple+json
+Accept: application/vnd.datamanager.pid.simple+json
+{
+    "record": [
+        { "key": "21.T11148/076759916209e5d62bd5", "value": "21.T11148/301c6f04763a16f0f72a" },
+        { "key": "21.T11148/397d831aa3a9d18eb52c", "value": "2021-12-21T17:36:09.541+00:00" },
+        { "key": "21.T11148/8074aed799118ac263ad", "value": "21.T11148/37d0f4689c6ea3301787" },
+        { "key": "21.T11148/92e200311a56800b3e47", "value": "{ \"sha256sum\": \"sha256 c50624fd5ddd2b9652b72e2d2eabcb31a54b777718ab6fb7e44b582c20239a7c\" }" },
+        { "key": "21.T11148/aafd5fb4c7222e2d950a", "value": "2021-12-21T17:36:09.541+00:00" },
+        { "key": "21.T11148/b8457812905b83046284", "value": "https://test.repo/noregistration321.zip" },
+        { "key": "21.T11148/c692273deb2772da307f", "value": "1.0.0" },
+        { "key": "21.T11148/c83481d4bf467110e7c9", "value": "21.T11148/ManuscriptPage" }
+    ]
+}
+
+# On success, we get a 200 (success). Note it is _not_ 201 (created)!
+HTTP 200
+# In the response body, you'll get the record and the pid
+[Captures]
+pid: jsonpath "$.pid"
+
+# If we resolve the pid...
+GET http://localhost:8090/api/v1/pit/pid/{{pid}}
+
+# ...we will not be able to get it, because we did not registered it (dry run / validation only)!
+HTTP 404