{"action":"created","issue":{"url":"https://api.github.com/repos/inadarei/rfc-healthcheck/issues/26","repository_url":"https://api.github.com/repos/inadarei/rfc-healthcheck","labels_url":"https://api.github.com/repos/inadarei/rfc-healthcheck/issues/26/labels{/name}","comments_url":"https://api.github.com/repos/inadarei/rfc-healthcheck/issues/26/comments","events_url":"https://api.github.com/repos/inadarei/rfc-healthcheck/issues/26/events","html_url":"https://github.com/inadarei/rfc-healthcheck/issues/26","id":372927864,"node_id":"MDU6SXNzdWUzNzI5Mjc4NjQ=","number":26,"title":"Version number considerations","user":{"login":"christianhujer","id":692345,"node_id":"MDQ6VXNlcjY5MjM0NQ==","avatar_url":"https://avatars1.githubusercontent.com/u/692345?v=4","gravatar_id":"","url":"https://api.github.com/users/christianhujer","html_url":"https://github.com/christianhujer","followers_url":"https://api.github.com/users/christianhujer/followers","following_url":"https://api.github.com/users/christianhujer/following{/other_user}","gists_url":"https://api.github.com/users/christianhujer/gists{/gist_id}","starred_url":"https://api.github.com/users/christianhujer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/christianhujer/subscriptions","organizations_url":"https://api.github.com/users/christianhujer/orgs","repos_url":"https://api.github.com/users/christianhujer/repos","events_url":"https://api.github.com/users/christianhujer/events{/privacy}","received_events_url":"https://api.github.com/users/christianhujer/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":11,"created_at":"2018-10-23T10:31:33Z","updated_at":"2018-10-28T18:56:30Z","closed_at":null,"author_association":"NONE","body":"General practice disagrees with a statement made about version numbers in the (otherwise great, I already recommend this to projects!) draft. The draft states:\r\n\r\n> in well-designed APIs, backwards-compatible changes in the service should not update a version number.\r\n\r\nHowever, a lot of people follow semantic versioning, which has the benefit that it is possible to tell, by comparing two version numbers, whether the difference is bugfixes (1.2.7 to 1.2.8), new features (1.2.7 to 1.3.0), or compatibility-breaking changes (1.2.7 to 2.0.0).\r\n\r\nI would like to interpret `version` to be a version that ideally would follow semantic versioning, and `releaseID` can be something quite customized, like a git commit hash or build number.\r\n\r\nTherefore I suggest to change the statement \"in well-designed APIs, backwards-compatible changes in the service should not update a version number\" to \"in well-design APIs, it can be told from update of a version number whether the changes are backwards-compatible\".\r\n\r\nIn case readers haven't heard of semantic versioning, here's a link: https://semver.org/"},"comment":{"url":"https://api.github.com/repos/inadarei/rfc-healthcheck/issues/comments/433731680","html_url":"https://github.com/inadarei/rfc-healthcheck/issues/26#issuecomment-433731680","issue_url":"https://api.github.com/repos/inadarei/rfc-healthcheck/issues/26","id":433731680,"node_id":"MDEyOklzc3VlQ29tbWVudDQzMzczMTY4MA==","user":{"login":"inadarei","id":30158,"node_id":"MDQ6VXNlcjMwMTU4","avatar_url":"https://avatars1.githubusercontent.com/u/30158?v=4","gravatar_id":"","url":"https://api.github.com/users/inadarei","html_url":"https://github.com/inadarei","followers_url":"https://api.github.com/users/inadarei/followers","following_url":"https://api.github.com/users/inadarei/following{/other_user}","gists_url":"https://api.github.com/users/inadarei/gists{/gist_id}","starred_url":"https://api.github.com/users/inadarei/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/inadarei/subscriptions","organizations_url":"https://api.github.com/users/inadarei/orgs","repos_url":"https://api.github.com/users/inadarei/repos","events_url":"https://api.github.com/users/inadarei/events{/privacy}","received_events_url":"https://api.github.com/users/inadarei/received_events","type":"User","site_admin":false},"created_at":"2018-10-28T18:56:30Z","updated_at":"2018-10-28T18:56:30Z","author_association":"OWNER","body":"@randallsquared why would a health check endpoint report any version or releadeId of the main API?\r\n\r\n@dret I think home link should be a MAY statement. I can see many people deciding that the pointer should be from the API to the healthcheck and not vice versa, while other may like the direction, so this spec should avoid over-prescribing either of the approaches?"}}
{"actor":{"display_login":"inadarei"}}