{"action":"created","issue":{"url":"https://api.github.com/repos/swagger-api/swagger-spec/issues/423","labels_url":"https://api.github.com/repos/swagger-api/swagger-spec/issues/423/labels{/name}","comments_url":"https://api.github.com/repos/swagger-api/swagger-spec/issues/423/comments","events_url":"https://api.github.com/repos/swagger-api/swagger-spec/issues/423/events","html_url":"https://github.com/swagger-api/swagger-spec/issues/423","id":97174110,"number":423,"title":"operationId: is it machine-first or people-first?","user":{"login":"earth2marsh","id":54582,"avatar_url":"https://avatars.githubusercontent.com/u/54582?v=3","gravatar_id":"","url":"https://api.github.com/users/earth2marsh","html_url":"https://github.com/earth2marsh","followers_url":"https://api.github.com/users/earth2marsh/followers","following_url":"https://api.github.com/users/earth2marsh/following{/other_user}","gists_url":"https://api.github.com/users/earth2marsh/gists{/gist_id}","starred_url":"https://api.github.com/users/earth2marsh/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/earth2marsh/subscriptions","organizations_url":"https://api.github.com/users/earth2marsh/orgs","repos_url":"https://api.github.com/users/earth2marsh/repos","events_url":"https://api.github.com/users/earth2marsh/events{/privacy}","received_events_url":"https://api.github.com/users/earth2marsh/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":3,"created_at":"2015-07-25T00:23:39Z","updated_at":"2015-07-26T14:36:57Z","closed_at":null,"body":"operationId, from the spec description: \r\n```\r\nA friendly name for the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operation id to uniquely identify an operation.\r\n```\r\nWhen I see \"friendly name\" I think human-friendly, and that suggests I can use spaces. The Swagger schema declares it a string without any length restrictions, AFAICT. \r\n\r\nHowever, given that \"it MAY be used by tools and libraries,\" that suggests it is a machine-friendly name first, especially that the attribute contains \"ID\" rather than \"name\".  \r\n\r\nMay I suggest either adding a pattern in the spec to restrict what characters can be used, and/or else consider adding a proper \"name\" field for operations. (NB: could use the summary field for that, but it's poorly named for that role, itself.)"},"comment":{"url":"https://api.github.com/repos/swagger-api/swagger-spec/issues/comments/124997867","html_url":"https://github.com/swagger-api/swagger-spec/issues/423#issuecomment-124997867","issue_url":"https://api.github.com/repos/swagger-api/swagger-spec/issues/423","id":124997867,"user":{"login":"webron","id":241629,"avatar_url":"https://avatars.githubusercontent.com/u/241629?v=3","gravatar_id":"","url":"https://api.github.com/users/webron","html_url":"https://github.com/webron","followers_url":"https://api.github.com/users/webron/followers","following_url":"https://api.github.com/users/webron/following{/other_user}","gists_url":"https://api.github.com/users/webron/gists{/gist_id}","starred_url":"https://api.github.com/users/webron/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/webron/subscriptions","organizations_url":"https://api.github.com/users/webron/orgs","repos_url":"https://api.github.com/users/webron/repos","events_url":"https://api.github.com/users/webron/events{/privacy}","received_events_url":"https://api.github.com/users/webron/received_events","type":"User","site_admin":false},"created_at":"2015-07-26T14:36:57Z","updated_at":"2015-07-26T14:36:57Z","body":"Unfortunately, for 2.0, I'm going disagree with you. The text says MAY, not SHOULD, and there's a reason for it. We actually discussed imposing additional restrictions on the field. However, using it as an identified by machine is not as simple as it sounds. Different languages use different naming standards and sometimes permit different characters. We can, theoretically, restrict the the characters to the lowest known character subset, but that solves half the problem and we really didn't want to get into it. It is up to the tools to perform the processing of this field, should they choose to, and morph it to the standards they need, I don't see any problem removing spaces, as much as I don't see any problem changing character case style.\r\n\r\nAs for machine readable vs human readable, there have been requests to add it to the UI as a displayed field because some users use it to communicate specific operations between themselves. So, I don't know really. If it's machine readable only, it could just be a uuid 😉\r\n\r\nWe can reopen it for debate for the future version, of course, but we won't make everyone happy here."}}