{"action":"closed","issue":{"url":"https://api.github.com/repos/swagger-api/swagger-codegen/issues/3835","repository_url":"https://api.github.com/repos/swagger-api/swagger-codegen","labels_url":"https://api.github.com/repos/swagger-api/swagger-codegen/issues/3835/labels{/name}","comments_url":"https://api.github.com/repos/swagger-api/swagger-codegen/issues/3835/comments","events_url":"https://api.github.com/repos/swagger-api/swagger-codegen/issues/3835/events","html_url":"https://github.com/swagger-api/swagger-codegen/issues/3835","id":178013189,"number":3835,"title":"Android Client missing ApiKeyAuth example in the README","user":{"login":"loretoparisi","id":163333,"avatar_url":"https://avatars.githubusercontent.com/u/163333?v=3","gravatar_id":"","url":"https://api.github.com/users/loretoparisi","html_url":"https://github.com/loretoparisi","followers_url":"https://api.github.com/users/loretoparisi/followers","following_url":"https://api.github.com/users/loretoparisi/following{/other_user}","gists_url":"https://api.github.com/users/loretoparisi/gists{/gist_id}","starred_url":"https://api.github.com/users/loretoparisi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/loretoparisi/subscriptions","organizations_url":"https://api.github.com/users/loretoparisi/orgs","repos_url":"https://api.github.com/users/loretoparisi/repos","events_url":"https://api.github.com/users/loretoparisi/events{/privacy}","received_events_url":"https://api.github.com/users/loretoparisi/received_events","type":"User","site_admin":false},"labels":[{"id":160493185,"url":"https://api.github.com/repos/swagger-api/swagger-codegen/labels/Client:%20Android","name":"Client: Android","color":"fad8c7","default":false},{"id":64180588,"url":"https://api.github.com/repos/swagger-api/swagger-codegen/labels/Feature:%20Documentation","name":"Feature: Documentation","color":"eeccff","default":false},{"id":64180581,"url":"https://api.github.com/repos/swagger-api/swagger-codegen/labels/Issue:%20Bug","name":"Issue: Bug","color":"e11d21","default":false}],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":{"url":"https://api.github.com/repos/swagger-api/swagger-codegen/milestones/13","html_url":"https://github.com/swagger-api/swagger-codegen/milestones/v2.2.2","labels_url":"https://api.github.com/repos/swagger-api/swagger-codegen/milestones/13/labels","id":1928763,"number":13,"title":"v2.2.2","description":"","creator":{"login":"wing328","id":934260,"avatar_url":"https://avatars.githubusercontent.com/u/934260?v=3","gravatar_id":"","url":"https://api.github.com/users/wing328","html_url":"https://github.com/wing328","followers_url":"https://api.github.com/users/wing328/followers","following_url":"https://api.github.com/users/wing328/following{/other_user}","gists_url":"https://api.github.com/users/wing328/gists{/gist_id}","starred_url":"https://api.github.com/users/wing328/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wing328/subscriptions","organizations_url":"https://api.github.com/users/wing328/orgs","repos_url":"https://api.github.com/users/wing328/repos","events_url":"https://api.github.com/users/wing328/events{/privacy}","received_events_url":"https://api.github.com/users/wing328/received_events","type":"User","site_admin":false},"open_issues":280,"closed_issues":362,"state":"open","created_at":"2016-08-08T09:16:56Z","updated_at":"2016-11-02T07:46:07Z","due_on":null,"closed_at":null},"comments":16,"created_at":"2016-09-20T09:41:27Z","updated_at":"2016-11-02T07:46:07Z","closed_at":"2016-11-02T07:46:07Z","body":"##### Description\n\nWhen generating the `android-client` from the Swagger Editor  - https://editor.swagger.io, the autogen `README.md` is missing an example of how the authentication works:\n\n``` java\nimport io.swagger.client.api.AlbumApi;\n\npublic class AlbumApiExample {\n\n    public static void main(String[] args) {\n        AlbumApi apiInstance = new AlbumApi();\n        String albumId = \"albumId_example\"; // String | The musiXmatch album id\n        String format = \"json\"; // String | output format: json, jsonp, xml.\n        String callback = \"callback_example\"; // String | jsonp callback\n        try {\n            InlineResponse200 result = apiInstance.albumGetGet(albumId, format, callback);\n            System.out.println(result);\n        } catch (ApiException e) {\n            System.err.println(\"Exception when calling AlbumApi#albumGetGet\");\n            e.printStackTrace();\n        }\n    }\n}\n```\n\nthat actually it is missing also some exceptions, so it should be at least:\n\n``` java\n\n        public void AlbumAPIGet() {\n\n            AlbumApi apiInstance = new AlbumApi();\n            String albumId = \"albumId_example\"; // String | The musiXmatch album id\n            String format = \"json\"; // String | output format: json, jsonp, xml.\n            String callback = \"callback_example\"; // String | jsonp callback\n            try {\n                InlineResponse200 result = apiInstance.albumGetGet(albumId, format, callback);\n                System.out.println(result);\n            } catch (ApiException e) {\n                System.err.println(\"ApiException when calling AlbumApi#albumGetGet\");\n                e.printStackTrace();\n            } catch (java.util.concurrent.TimeoutException e) {\n                System.err.println(\"TimeoutException when calling AlbumApi#albumGetGet\");\n                e.printStackTrace();\n            } catch (java.util.concurrent.ExecutionException e) {\n                System.err.println(\"ExecutionException when calling AlbumApi#albumGetGet\");\n                e.printStackTrace();\n            } catch (java.lang.InterruptedException e) {\n                System.err.println(\"InterruptedException when calling AlbumApi#albumGetGet\");\n                e.printStackTrace();\n            }\n        }\n    }\n```\n\nIn the `README.md` there is no reference about the `ApiKeyAuth`, how to load it and how to set the api key for the current client configuration.\n##### Swagger-codegen version\n\nLatest version available from https://editor.swagger.io\n##### Swagger declaration file content or url\n\nThis is my swagger declaration file: https://playground.musixmatch.com/swagger.json\n##### Command line used for generation\n\nLatest version available from https://editor.swagger.io\n##### Steps to reproduce\n1. import from url the swagger definition above in the Swagger Editor\n2. Generate the Android client\n3. Open README.md\n##### Related issues\n\n<!-- has a similar issue been reported before? Please do a search in https://github.com/swagger-api/swagger-codegen/issues?utf8=%E2%9C%93&q=is%3Aissue%20 -->\n##### Suggest a Fix\n\n<!-- if you can't fix the bug yourself, perhaps you can point to what might be\n  causing the problem (line of code or commit) -->\n"}}
{"actor":{"display_login":"wing328"}}