{"action":"closed","issue":{"url":"https://api.github.com/repos/juju/docs/issues/378","labels_url":"https://api.github.com/repos/juju/docs/issues/378/labels{/name}","comments_url":"https://api.github.com/repos/juju/docs/issues/378/comments","events_url":"https://api.github.com/repos/juju/docs/issues/378/events","html_url":"https://github.com/juju/docs/issues/378","id":69604069,"number":378,"title":"Documentation is confusing for Juju Charm Actions","user":{"login":"mitechie","id":75915,"avatar_url":"https://avatars.githubusercontent.com/u/75915?v=3","gravatar_id":"","url":"https://api.github.com/users/mitechie","html_url":"https://github.com/mitechie","followers_url":"https://api.github.com/users/mitechie/followers","following_url":"https://api.github.com/users/mitechie/following{/other_user}","gists_url":"https://api.github.com/users/mitechie/gists{/gist_id}","starred_url":"https://api.github.com/users/mitechie/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mitechie/subscriptions","organizations_url":"https://api.github.com/users/mitechie/orgs","repos_url":"https://api.github.com/users/mitechie/repos","events_url":"https://api.github.com/users/mitechie/events{/privacy}","received_events_url":"https://api.github.com/users/mitechie/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2015-04-20T14:47:15Z","updated_at":"2015-06-03T11:13:23Z","closed_at":"2015-06-03T11:13:23Z","body":"ported from https://github.com/CanonicalLtd/jujucharms.com/issues/88\r\n\r\nhttps://jujucharms.com/docs/1.20/authors-charm-actions\r\n\r\nAbout 1/3 of the way down the page.\r\n\r\nThe example schema for a Juju Action specifies that the actions directory should contain the 2 executables (report and run). \r\n\r\nYet the schema specified below specifies that the name of the script should be \"snapshot.\" \r\n\r\nAs well as the example command provided:\r\n\r\njuju action do mysql/0 snapshot filename=out.tar.gz compression.type=gzip \r\n\r\n\r\nExample Schema\r\n\r\nCharm dir\r\n├── actions\r\n│   ├── report  <--------------------------------- Should this be snapshot ????\r\n│   └── run\r\n├── actions.yaml\r\n...\r\n\r\nactions.yaml example\r\n# actions.yaml\r\n\r\nreport:\r\nsnapshot: \r\n  description: Take a snapshot of the database.\r\n  params:\r\n    filename: \r\n      type: string\r\n      description: The name of the snapshot file.\r\n    compression:\r\n      type: object\r\n      description: The type of compression to use.\r\n      properties:\r\n        kind:\r\n          type: string\r\n          enum: [gzip, bzip2, xz]\r\n        quality:\r\n          description: Compression quality\r\n          type: integer\r\n          minimum: 0\r\n          maximum: 9\r\n  required: [filename]\r\n  additionalProperties: false\r\n\r\ncopying @puravidahope"}}