René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"inconsistency API on get, update and create","articleBody":"please point me to the right documentation if I understand it incorrectly. \r\nit seems some inconsistency on get_, update_ and create_ API \r\nI am using \"dashboard\" as example \r\n\r\napi/dashboard_api.py::get_ and update_ requires a parameter id.\r\n\r\n```\r\ndef get_dashboard(self, id, **kwargs)\r\n```\r\n\r\nbut for dashboard. it requires both id and url be unique \r\nwavefront_api_client/models/dashboard.py\r\n\r\n```\r\n@id.setter\r\n    def id(self, id):\r\n        \"\"\"Sets the id of this Dashboard.\r\n        Unique identifier, also URL slug, of the dashboard  # noqa: E501\r\n        :param id: The id of this Dashboard.  # noqa: E501\r\n        :type: str\r\n        \"\"\"\r\n        if id is None:\r\n            raise ValueError(\"Invalid value for `id`, must not be `None`\")  # noqa: E501\r\n\r\n        self._id = id\r\n\r\n@property\r\n    def url(self):\r\n        \"\"\"Gets the url of this Dashboard.  # noqa: E501\r\n        Unique identifier, also URL slug, of the dashboard  # noqa: E501\r\n        :return: The url of this Dashboard.  # noqa: E501\r\n        :rtype: str\r\n        \"\"\"\r\n        return self._url\r\n```\r\n\r\nthat creates a problem. when I need to create a new dashboard. How do I verify I am able to create the dashboard?  \r\n\r\nexample:\r\ncurrently I already have a dashboard on wavefront called: dashboard1 it has \r\n\r\n- id:dashboard1\r\n- url: dashboard1\r\n\r\nand user defined a new text file dashboard2.txt. in dashboard2.txt defines\r\n- id: dashboard2\r\n- url: dashboard1\r\n\r\nwhen I try to create new dashboard2, I can find \"id\" from dashboard2.txt, and check it via \r\n```\r\napi_instance.get_dashboard(id)\r\n```\r\nsince dashboard2 has id \"dashboard2\", I will get 404 back from get_dashboard, then I assuming it's safe to create new dashboard2 by calling \r\n```\r\napi_instance.create_dashboard(body=content_of(dashboard2.txt))\r\n```\r\nbut this will result in error\r\n\u003e {\"status\":{\"result\":\"ERROR\",\"message\":\"Unable to create the dashboard.  Perhaps a dashboard already exists at id dashboard1\",\"code\":400}}\r\n\r\nit's similar for update_dashboard. if I have 2 dashboard on wavefront already, it has url: dashboard1 and dashboard2, and I am trying to update dashboard1 with url \"dashboard2\" it will result in similar error. \r\n\r\nI understand I can call **get_all_dashboard** and iterate over to find all id/url or I can just use \"try ... except\" then try to do string match from error message, but wavefront should provide a better way to allow user to write **predictable code.** (try...except feels not that predictable).  We migrate to wavefront this year (couple month ago) and currently we already have 438 pages of dashboard. (I think it's 25 per page) so iterate over all dashboard doesn't work well either. \r\n\r\nif there's already code to empower user to do what I described above, then I would suggest to update documentation so users can easily find the answer. ( I didn't read the source, I was reading trying to only read Python SDK documentation linked from README.md)","author":{"url":"https://github.com/ruivapps","@type":"Person","name":"ruivapps"},"datePublished":"2018-07-26T20:37:05.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/42/python-client/issues/42"}