Skip to content

Superschema + some post-alpha schema changes#14

Merged
FrederikP merged 29 commits intomasterfrom
superschema
Jul 29, 2020
Merged

Superschema + some post-alpha schema changes#14
FrederikP merged 29 commits intomasterfrom
superschema

Conversation

@FrederikP
Copy link
Copy Markdown
Collaborator

@FrederikP FrederikP commented Jul 24, 2020

This introduces a new versioning mechanism. Old versions and the current development preview are always part of the "superschema". This makes it simpler for parser software to be able to parse multiple versions of XARF.

Summary:

  • schemas/ now contains one subfolder per version including the latest development preview in development
  • samples/ now contains a positive and negative subfolder and each of them contains one sample folder per version
  • top level property Version has to be set in all new versions, it is not required for alpha
  • version alpha contains all work so far and the version that currently some organizations are already using. no incompatible changes have been performed
  • version development should not be used in production. It is unstable and always contains the changes that will be introduced in the next version
  • schema changes:
    • InfringingUrl from trademark and copyright. SourceUrl should be used from now on
    • Renamed mail sender and recipient: ToAddress -> SmtpRcptToAddress, FromAddress -> SmtpMailFromAddress
  • added open service type
  • test coverage has been increased
  • negative test samples have been added
  • a release script has been added to simplify releasing a new version
  • added a changelog

@FrederikP FrederikP changed the title WIP: Superschema + some post-alpha schema changes Superschema + some post-alpha schema changes Jul 27, 2020
Copy link
Copy Markdown
Contributor

@Maximilian-Staab Maximilian-Staab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just minor things. One copy-paste error and some suggestions to the new OpenService type.

Comment thread schemas/development/openservice.schema.json Outdated
Comment thread schemas/development/openservice.schema.json Outdated
Comment thread schemas/development/openservice.schema.json
Comment thread schemas/development/openservice.schema.json Outdated
Comment thread schemas/development/openservice.schema.json Outdated
FrederikP and others added 3 commits July 29, 2020 13:01
Co-authored-by: MaximilianS <maximilian.staab@mailbox.org>
Co-authored-by: MaximilianS <maximilian.staab@mailbox.org>
@@ -27,15 +27,10 @@
"enum": ["OpenService"]
},
"Service": {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would have expected an approach more to eg. WithTrafficStats or WithDestination.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I started implementing the Service shared type and would like to propose that. Do you know of a way to add a MR to a MR xD?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Example

xarf_shared

"Service": {
    "type": "object",
    "description": "Specify a service to report",
    "required": ["ServiceName"],
    "properties": {
        "ServiceName": {
            "type": "string"
         },
         "ServiceVersion": {
             "type": "string",
             "description": "Affected service version or version range"
         }
    }
},
"TransportProtocol": {
    "type": "object",
    "description": "Transport protocol used by the reportee",
    "properties": {
        "TransportProtocol": {
            "type": "string",
            "enum": ["tcp", "udp"]
        }
    }
}

Usage

{
    "$ref": "xarf_shared.schema.json#/TransportProtocol"
},
{
    "$ref": "xarf_shared.schema.json#/Service"
}

@FrederikP FrederikP merged commit 7a65f13 into master Jul 29, 2020
@FrederikP FrederikP deleted the superschema branch July 29, 2020 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Trademark schema uses InfringingUrl, which is already covered by SourceUrl

2 participants