Merge branch 'dev'

bin/generate-input-parameter-schema.pl

@@ -23,6 +23,8 @@
 
     $schema->{$name}->{'description'} = $meta{'Description'};
     $schema->{$name}->{'example'} = $meta{'Example'} if (exists($meta{'Example'}));
+
+    add_constraints($schema->{$name});
 }
 
 say STDERR 'generating YAML fragment for input parameter schemas...';
@@ -34,3 +36,34 @@
 print $yaml;
 
 say STDERR 'done';
+
+sub add_constraints {
+    my $schema = shift;
+
+    if ('url' eq $schema->{format}) {
+        $schema->{'x-constraints'} = '@ValidUrl';
+
+    } elsif ('hostname' eq $schema->{format}) {
+        $schema->{'x-constraints'} = '@ValidHostname';
+
+    } elsif ('array' eq $schema->{type}) {
+        if ('hostname' eq $schema->{items}->{format}) {
+            $schema->{'x-constraints'} = '@ValidHostnameList';
+
+        } elsif ('ipv4' eq $schema->{items}->{format}) {
+            $schema->{'x-constraints'} = '@ValidIpv4List';
+
+        } elsif ('ipv6' eq $schema->{items}->{format}) {
+            $schema->{'x-constraints'} = '@ValidIpv6List';
+
+        } else {
+            add_constraints($schema->{items}) if ($schema->{items});
+
+        }
+
+    } elsif ('object' eq $schema->{type}) {
+        foreach my $property (keys(%{$schema->{properties}})) {
+            add_constraints($schema->{properties}->{$property});
+        }
+    }
+}

inc/test-request-base-properties.yaml

@@ -10,9 +10,8 @@ rsp:
   description: |
     The RSP's unique ID.
 
-    In OT&E, this **MUST** be omitted when creating a new test request, and will
-    be populated using the FQDN of the first `TLSA` record which matches the
-    certificate presented by the client.
+    In OT&E, this **MUST** contain the Fully-Qualified Domain Name where a TLSA
+    record that validates the client certificate is published.
   type: string
   example: RSPI2404-M51
 
@@ -111,9 +110,8 @@ clientIDs:
     An array of FQDNs at which one or more `TLSA` records may be found
     which can be used for authentication.
 
-    In OT&E, this **MUST** be omitted when creating a new test request, but the
-    resulting test will be populated with the FQDN of the first `TLSA` record
-    which matches the certificate presented by the client.
+    In OT&E, this **MUST** contain the Fully-Qualified Domain Name where a TLSA
+    record that validates the client certificate is published.
   type: array
   minItems: 1
   items:

rst-api-spec.yaml.in

@@ -80,6 +80,13 @@ info:
 
     ### Change Log
 
+    * 2024-07-03:
+      * `x-constraints` properties have been added to input parameter schemas,
+        where appropriate, to facilitate automated validation in Java
+        applications.
+      * When creating tests in the OT&E environment, the `rsp` and `clientIDs`
+        **MUST** now be specified and **MUST** contain the FQDN at which a TLSA
+        record that validates the client certificate is published.
     * 2024-06-26:
       * added the `/v1/resource/{file}` endpoint.
     * 2024-06-05: