feat: add message schemas and shapes #3

sebbader-sap · 2022-12-20T15:33:24Z

Closes #17
Closes #18
Closes #19

jimmarino · 2022-12-20T15:42:59Z

schemas/contract-negotiation-error-message-schema.json

+				},
+				"ids:rejectionReason": {
+					"type": "string",
+					"enum": [


I don't think we should define this (the enum)

This is already part of the current info model. We can take a look if there is a different vocabulary out there. Not defining its values is however not an option.

Why is this not an option? If you leave it open as String, one could add information as needed. And its processing COULD be defined in the protocol binding - if you want to enforce a unified processing.

from our call:

enum is not the right keyword

syntactic or message-related errors must result in protocol-native error codes

we can recommend certain "well-known" values and a pattern (e.g. "COUNTER_OFFER_NOT_ACCEPTABLE")

Idea: move the rejectionReason to the NegotiationTerminationMessage field terminationReason?

I will update the files accordingly.

sebbader-sap · 2023-01-20T16:56:16Z

@jimmarino @juliapampus I am done with the first iteration in the message schemas.

catalog/catalog.protocol.md

juliapampus · 2023-01-23T07:53:46Z

negotiation/contract.negotiation.protocol.md


-**Response**: [ContractNegotiation](./message/contract.negotiation.json) containing the negotiation id or ERROR.
+**Response**: [ContractNegotiationMessage](./message/contract-negotiation-message.json) containing the negotiation id or ERROR.


Same as above. The response should not be a message but the object, in this case ids:ContractNegotiation.

juliapampus · 2023-01-23T07:57:28Z

negotiation/message/contract-negotiation-error-message.puml

+    dct:description : MultilanguageProperty
+}
+
+enum ids:RejectionReason {


We didn't want to predefine rejection reasons, right? Because the error code should be protocol binding specific. So just ids:errorCode or ids:code of type String.

juliapampus · 2023-01-23T07:59:23Z

negotiation/message/contract-negotiation-message.json

@@ -1,7 +1,7 @@
 {
  "@context":  "https://w3id.org/idsa/v5/context.json",
  "@id": "urn:uuid:a343fcbf-99fc-4ce8-8e9b-148c97605aab",
-  "@type": "ids:ContractNegotiation",
+  "@type": "ids:ContractNegotiationMessage",


As above, this thing here defines the ids:ContractNegotiation that should not be wrapped into a ContractNegotiationMessage as response.

juliapampus · 2023-01-23T08:04:20Z

negotiation/message/contract-negotiation-termination-message.puml

+    @type : "ids:ContractNegotiationTerminationMessage"
+    ids:processId : String
+    ids:code : ids:TerminationCode
+    ids:reason : ids:Reason


Referring to my comment above, we should keep ids:code and not replace it by ids:rejectionReason. So, IMO it is okay to have this reason value as an add-on. Nevertheless, I don't think we should put effort in pre-defining ids rejection reasons.

sebbader-sap · 2023-02-15T14:22:03Z

I have finished the main work on the schemas. A colleague of mine will do a quality check and also provide schemas for DCAT Catalogs and ODRL later.
Following topics are open:

TransferSuspensionMessage or not?
Making ids:code --> String makes it unusable for any interoperable use case. Either we remove it or provide an (extendable) list of initial codes. Actually, Clarify the Attributes of the ContractNegotiationTerminationMessage #8 asks the same question. We can discuss it there and fix it outside of this PR.
same for rejectionReason
Is processId optional?

juliapampus · 2023-02-16T20:33:44Z

I think some changes need a dedicated approval/discussion @jimmarino

ContractAgreementVerificationMessage has undiscussed content (?)
ids:rejectionReason is introduced as an enum (+ inconsistent with transfer message JSONs)
dct:description is introduced for some objects (why at all, or why not for all objects?)
ids:code is introduced as enum (not everywhere)
- TransferTerminationMessage introduces ids:code as object
incosistent naming of ids:reasons / ids:reasons (I remember we agreed on singular?)
in contract.negotiation.protocol.md line 86, callbackAdress is defined as URL

I have some local cleaned up history, however, this will require more effort than just cherry-picking some commits/changes. How to proceed?

…const"

juliapampus · 2023-02-17T14:59:53Z

Relates #35

sebbader-sap · 2023-02-22T09:51:50Z

@juliapampus your changes are fine with me, thanks for the effort!
The PR can be merged from my end. Additional tasks, e.g. #39, can be done in a follow-up PR.

jimmarino

Due to the length, it's a bit hard to go through specifics. I'm fine in principle as long as the enums are removed/

catalog subtask changes

jimmarino reviewed Dec 20, 2022

View reviewed changes

sebbader-sap marked this pull request as ready for review January 20, 2023 16:55

juliapampus requested changes Jan 23, 2023

View reviewed changes

This was referenced Feb 15, 2023

Add details for TransferSuspensionMessage #19

Closed

Add details for TransferTerminationMessage #18

Closed

Add details for TransferCompletionMessage #17

Closed

ssteinbuss requested review from jimmarino and juliapampus February 16, 2023 09:14

juliapampus self-assigned this Feb 17, 2023

sebbader-sap added 2 commits February 17, 2023 11:31

feat: add message schemes for contract negotiation

3f3b76b

feat: add message schemes for cataloging

acabe76

juliapampus force-pushed the sebbader/schema-shapes branch from ecc5503 to 6a4be50 Compare February 17, 2023 10:34

sebbader-sap added 2 commits February 17, 2023 15:09

feat: add message schemes for transfer process

41261c9

refactor: replace JSON schema keyword "pattern" with better fitting "…

1a340f6

…const"

juliapampus force-pushed the sebbader/schema-shapes branch from 6a4be50 to b2c5efe Compare February 17, 2023 14:10

juliapampus added 2 commits February 17, 2023 15:34

fix: revert not discussed changes

ec50761

fix: resolve broken links and typos

c4bee2a

juliapampus force-pushed the sebbader/schema-shapes branch from b2c5efe to 6950efe Compare February 17, 2023 14:52

juliapampus requested review from jimmarino and removed request for jimmarino February 17, 2023 14:53

juliapampus changed the title ~~Message Schemas~~ feat: add message schemas and shapes Feb 17, 2023

refactor: clean up file structure

281f5fb

juliapampus force-pushed the sebbader/schema-shapes branch from 6950efe to 281f5fb Compare February 17, 2023 15:17

sebbader-sap and others added 2 commits February 22, 2023 10:45

fix: broken link to the negotiation error diagram

36e9960

Merge branch 'main' into sebbader/schema-shapes

1570825

jimmarino approved these changes Feb 22, 2023

View reviewed changes

juliapampus approved these changes Feb 22, 2023

View reviewed changes

juliapampus merged commit 15be6d2 into main Feb 22, 2023

juliapampus deleted the sebbader/schema-shapes branch February 22, 2023 11:58

jimmarino mentioned this pull request Jun 1, 2023

Introduce best practices document #104

Closed

sebbader-sap pushed a commit that referenced this pull request Sep 25, 2023

Merge pull request #3 from simantvermasap/catalog-subtask

1b110bf

catalog subtask changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add message schemas and shapes #3

feat: add message schemas and shapes #3

sebbader-sap commented Dec 20, 2022 •

edited by juliapampus

Loading

jimmarino Dec 20, 2022 •

edited

Loading

sebbader-sap Jan 20, 2023

juliapampus Jan 23, 2023

sebbader-sap Jan 26, 2023

sebbader-sap Jan 26, 2023

sebbader-sap commented Jan 20, 2023

juliapampus Jan 23, 2023

sebbader-sap Feb 15, 2023

juliapampus Jan 23, 2023

juliapampus Jan 23, 2023

juliapampus Jan 23, 2023

sebbader-sap commented Feb 15, 2023 •

edited

Loading

juliapampus commented Feb 16, 2023 •

edited

Loading

juliapampus commented Feb 17, 2023

sebbader-sap commented Feb 22, 2023

jimmarino left a comment


		Response: [ContractNegotiation](./message/contract.negotiation.json) containing the negotiation id or ERROR.
		Response: [ContractNegotiationMessage](./message/contract-negotiation-message.json) containing the negotiation id or ERROR.

feat: add message schemas and shapes #3

feat: add message schemas and shapes #3

Conversation

sebbader-sap commented Dec 20, 2022 • edited by juliapampus Loading

jimmarino Dec 20, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sebbader-sap commented Jan 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sebbader-sap commented Feb 15, 2023 • edited Loading

juliapampus commented Feb 16, 2023 • edited Loading

juliapampus commented Feb 17, 2023

sebbader-sap commented Feb 22, 2023

jimmarino left a comment

Choose a reason for hiding this comment

sebbader-sap commented Dec 20, 2022 •

edited by juliapampus

Loading

jimmarino Dec 20, 2022 •

edited

Loading

sebbader-sap commented Feb 15, 2023 •

edited

Loading

juliapampus commented Feb 16, 2023 •

edited

Loading