update readme, Bruno collection

Author: paullatzelsperger

README.md

@@ -0,0 +1,32 @@
+meta {
+  name: Download Data from Public API
+  type: http
+  seq: 9
+}
+
+get {
+  url: {{PROVIDER_PUBLIC_URL}}/api/public
+  body: none
+  auth: none
+}
+
+headers {
+  Authorization: {{AUTHORIZATION}}
+}
+
+script:pre-request {
+  if(!(bru.getVar("AUTHORIZATION") !== undefined && bru.getVar("AUTHORIZATION") !== null)){
+      throw new Error(' The authorization token is not yet available, please execute request "Get EDR DataAddress for TransferId" first!');
+  }
+}
+
+script:post-response {
+  test("Status code is >=200 and <300", function () {
+      expect(res.getStatus() < 300 && res.getStatus() >= 200).to.be.true
+  });
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

Requests/ControlPlane Management/Download Data from Public API.bru

@@ -0,0 +1,37 @@
+meta {
+  name: Get Assets
+  type: http
+  seq: 1
+}
+
+post {
+  url: {{CONSUMER_CP}}/api/mgmt/v4beta/assets/request
+  body: json
+  auth: inherit
+}
+
+body:json {
+  {
+    "@type": "QuerySpec"
+  }
+}
+
+body:text {
+  {
+      "@context": {
+          "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
+      },
+      "@type": "QuerySpec"
+  }
+}
+
+script:post-response {
+  test("Status code is >=200 and <300", function () {
+      expect(res.getStatus() < 300 && res.getStatus() >= 200).to.be.true
+  });
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

Requests/ControlPlane Management/Get Assets.bru

@@ -0,0 +1,57 @@
+meta {
+  name: Get Contract Negotiations
+  type: http
+  seq: 4
+}
+
+post {
+  url: {{CONSUMER_CP}}/api/mgmt/v4beta/contractnegotiations/request
+  body: json
+  auth: inherit
+}
+
+body:json {
+  {
+    "@context": [
+      "https://w3id.org/edc/connector/management/v2"
+    ],
+    "@type": "QuerySpec"
+  }
+}
+
+body:text {
+  {
+     "@context": [
+      "https://w3id.org/edc/connector/management/v2"
+      ],
+      "@type": "QuerySpec"
+  }
+}
+
+script:post-response {
+  // get the contact agreement id and save it as an environment variable
+  if(res.getStatus() < 300 && res.getStatus() >= 200 && res.getBody().length > 0){
+      var find_negotiation;
+      if (bru.getVar("CONTRACT_NEGOTIATION_ID") !== undefined && bru.getVar("CONTRACT_NEGOTIATION_ID") !== null){
+          find_negotiation = res.getBody().find((el) => el["@id"] == bru.getVar("CONTRACT_NEGOTIATION_ID"))
+      }
+  
+      if(find_negotiation){
+          const contractAgreementId = find_negotiation["contractAgreementId"];
+          bru.setVar("CONTRACT_AGREEMENT_ID", contractAgreementId);
+      }
+  }
+  
+  test("Status code is >=200 and <300", function () {
+      expect(res.getStatus() < 300 && res.getStatus() >= 200).to.be.true
+  });
+  test("Contract Agreement ID is set", function(){
+      expect(bru.getVar("CONTRACT_AGREEMENT_ID")).not.to.be.undefined
+  })
+  
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

Requests/ControlPlane Management/Get Contract Negotiations.bru

@@ -0,0 +1,33 @@
+meta {
+  name: Get EDR DataAddress for TransferId
+  type: http
+  seq: 8
+}
+
+get {
+  url: {{CONSUMER_CP}}/api/mgmt/v4beta/edrs/{{TRANSFER_PROCESS_ID}}/dataaddress
+  body: none
+  auth: inherit
+}
+
+script:pre-request {
+  if(!(bru.getVar("TRANSFER_PROCESS_ID") !== undefined && bru.getVar("TRANSFER_PROCESS_ID") !== null)){
+      throw new Error('Transfer Process ID is not yet available, please execute request "Get Transfer Processes" first!');
+  }
+}
+
+script:post-response {
+  // get the authorization token and save it as an environment variable
+  if(res.getStatus() < 300 && res.getStatus() >= 200){
+    //using the first authorization token found
+    const authorization = res.getBody()["authorization"];
+    bru.setVar("AUTHORIZATION", authorization);
+  }
+  
+  
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

Requests/ControlPlane Management/Get EDR DataAddress for TransferId.bru

@@ -0,0 +1,50 @@
+meta {
+  name: Get cached EDRs
+  type: http
+  seq: 7
+}
+
+post {
+  url: {{CONSUMER_CP}}/api/mgmt/v4beta/edrs/request
+  body: json
+  auth: inherit
+}
+
+body:json {
+  {
+    "@context": [
+      "https://w3id.org/edc/connector/management/v2"
+    ],
+    "@type": "QuerySpec"
+  }
+}
+
+body:text {
+  {
+      "@context": [
+      "https://w3id.org/edc/connector/management/v2"
+      ],
+      "@type": "QuerySpec"
+  }
+}
+
+script:post-response {
+  // get the transfer process id of "asset-1" and save it as an environment variable if the response body is not empty
+  if(res.getStatus() < 300 && res.getStatus() >= 200 && res.getBody().length > 0){
+    const transferProcessId = res.getBody()[0]["transferProcessId"];
+    bru.setVar("TRANSFER_PROCESS_ID", transferProcessId);
+  }
+  
+  test("Status code is >=200 and <300", function () {
+      expect(res.getStatus() < 300 && res.getStatus() >= 200).to.be.true
+  });
+  test("Transfer process id is set", function(){
+      expect(bru.getVar("TRANSFER_PROCESS_ID")).not.to.be.undefined
+  })
+  
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

Requests/ControlPlane Management/Get cached EDRs.bru

@@ -0,0 +1,32 @@
+meta {
+  name: Get transfer processes
+  type: http
+  seq: 6
+}
+
+post {
+  url: {{CONSUMER_CP}}/api/mgmt/v4beta/transferprocesses/request
+  body: json
+  auth: inherit
+}
+
+body:json {
+  {
+    "@context": [
+      "https://w3id.org/edc/connector/management/v2"
+    ],
+    "@type": "QuerySpec"
+  }
+}
+
+script:post-response {
+  test("Status code is >=200 and <300", function () {
+      expect(res.getStatus() < 300 && res.getStatus() >= 200).to.be.true
+  });
+  
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

Requests/ControlPlane Management/Get transfer processes.bru

@@ -0,0 +1,47 @@
+meta {
+  name: Initiate Transfer
+  type: http
+  seq: 5
+}
+
+post {
+  url: {{CONSUMER_CP}}/api/mgmt/v4beta/transferprocesses
+  body: json
+  auth: inherit
+}
+
+body:json {
+  {
+    "@context": [
+      "https://w3id.org/edc/connector/management/v2"
+    ],
+    "assetId": "asset-1",
+    "@type": "TransferRequest",
+    "counterPartyAddress": "{{PROVIDER_DSP}}",
+    "connectorId": "{{PROVIDER_ID}}",
+    "contractId": "{{CONTRACT_AGREEMENT_ID}}",
+    "dataDestination": {
+      "type": "HttpProxy"
+    },
+    "protocol": "dataspace-protocol-http",
+    "transferType": "HttpData-PULL"
+  }
+}
+
+script:pre-request {
+  if(!(bru.getVar("CONTRACT_AGREEMENT_ID") !== undefined && bru.getVar("CONTRACT_AGREEMENT_ID") !== null)){
+      throw new Error('Contract Agreement ID is not yet available, please execute requests "Initiate Negotiation and Get Contract Negotiation" first!');
+  }
+}
+
+script:post-response {
+  test("Status code is >=200 and <300", function () {
+      expect(res.getStatus() < 300 && res.getStatus() >= 200).to.be.true
+  });
+  
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

Requests/ControlPlane Management/Initiate Transfer.bru

@@ -0,0 +1,62 @@
+meta {
+  name: Initiate negotiation
+  type: http
+  seq: 3
+}
+
+post {
+  url: {{CONSUMER_CP}}/api/mgmt/v4beta/contractnegotiations
+  body: json
+  auth: inherit
+}
+
+body:json {
+  {
+    "@context": [
+      "https://w3id.org/edc/connector/management/v2"
+    ],
+    "@type": "ContractRequest",
+    "counterPartyAddress": "{{PROVIDER_DSP}}",
+    "counterPartyId": "{{PROVIDER_ID}}",
+    "protocol": "dataspace-protocol-http:2025-1",
+    "policy": {
+      "@type": "Offer",
+      "@id": "{{POLICY_ID_ASSET_1}}",
+      "assigner": "{{PROVIDER_ID}}",
+      "permission": [],
+      "prohibition": [],
+      "obligation": {
+        "action": "use",
+        "constraint": {
+          "leftOperand": "ManufacturerCredential.part_types",
+          "operator": "eq",
+          "rightOperand": "non_critical"
+        }
+      },
+      "target": "asset-1"
+    },
+    "callbackAddresses": []
+  }
+}
+
+script:pre-request {
+  if(!(bru.getVar("POLICY_ID_ASSET_1") !== undefined && bru.getVar("POLICY_ID_ASSET_1") !== null)){
+      throw new Error('Policy-ID of Asset-1 is not yet available, please execute request "Get Cached Catalog" first!');
+  }
+}
+
+script:post-response {
+  bru.setVar("CONTRACT_NEGOTIATION_ID", res.getBody()["@id"])
+  
+  test("Status code is >=200 and <300", function () {
+      expect(res.getStatus() < 300 && res.getStatus() >= 200).to.be.true
+  });
+  test("Contract negotiation id is set", function(){
+      expect(bru.getVar("CONTRACT_NEGOTIATION_ID")).not.to.be.undefined
+  })
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}