SpaceApi / schema

SpaceAPI JSON schema files.
24 stars 14 forks source link

Removes issue report channel #47

Closed gidsi closed 4 years ago

gidsi commented 5 years ago

Right now the issue_report_channel is a bit weird: E.g.

{
  "contact": {
    "email": "foo@example.com"
  },
  "issue_report_channel": [
    "issue_email",
    "twitter"
  ]
}

Which would be valid but obviously doesn't make any sense.

I would remove it since we don't use it anyways.

dbrgn commented 5 years ago

I agree. It might make sense if the issue report channel could be something different than the contact channel (e.g. spaceapi@space.org vs hello@space.org), but if it always refers to a contact entry it's not that useful.

rnestler commented 5 years ago

I agree. It might make sense if the issue report channel could be something different than the contact channel (e.g. spaceapi@space.org vs hello@space.org), but if it always refers to a contact entry it's not that useful.

It can refer to a different email address, that is the entire reason that there is email and issue_email in the contacts field.

Also @gidsi :

{
  "contact": {
    "email": "foo@example.com"
  },
  "issue_report_channel": [
    "issue_email",
    "twitter"
  ]
}

Is not valid. The entries in issue_report_channel must exist in contact. Just because our validator approves doesn't mean it is valid in all cases :wink: .

dbrgn commented 5 years ago

Ah, I wasn't aware that there's an issue_mail field. In that case you're right, but if that field is defined why do we need the issue_report_channels?

gidsi commented 5 years ago

Ah, I wasn't aware that there's an issue_mail field. In that case you're right, but if that field is defined why do we need the issue_report_channels?

The issue_mail has to be an email address and i would assume that the issue_report_channel was defined because someone wanted to have their issues reported by e.g. twitter.

We don't need it at all since it's there to get "automated issue reports" which we currently don't provide.

I didn't want to touch the contact field yet, first things first :)

rnestler commented 4 years ago

As discussed offline: We'll remove the issue_report_channels. If we add automated issue reporting in the future, we could add it back to the schema but in a different form: For every contact field we add a boolean if it should be used for issue reporting. Something like:

"contact": {
    "email": {
        "value": "info@shackspace.de",
        "issue_report": true
    }
}

This removes the strange disconnection we currently have between the issue_report_channels and the contact fields.