Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [hono-dev] Definition of Hono's public API
  • From: Julian Feinauer <j.feinauer@xxxxxxxxxxxxxxxxx>
  • Date: Tue, 14 Jan 2020 08:02:05 +0000
  • Accept-language: de-DE, en-US
  • Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=pragmaticminds.de; dmarc=pass action=none header.from=pragmaticminds.de; dkim=pass header.d=pragmaticminds.de; arc=none
  • Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=Jlyz0ApXZqwdOLdEFBGExa6PqN9eQuY/0R3OlzWP37U=; b=O6+l2urvI2j+RTVOjpm43evGnhafGvg4dJgOvEeqs7E+j6/mTClp0efuozZ5ObRth5iF/7zMbDyYVZ/9kg2R0CFpMUMYBBnJpH9gfghH4TLSyIslpVCQGQTgmK4NuE7Y0bjDdJqUfLSCa3Q0gKimXzFvVZC4XeLWQyg9YZzFh+B/MmMzbZwD4poTDqlBLSPJvhyZK+hMV85iUwdceOFjamFZ3YvuULU1TxDWblyiG7jVQH3LXFe/8HPAiscCy1Z69NBRvdVcD7Xy3oCpLmYeA9x3NPIdHFRf4itht54IzO42Ka5XSnHimjL+a+xpKhjbq6XiVutzAdPV9SyL1k4t6Q==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=ddFm/c4f/S6ZrPHdB8XMiIveSUFHfa7HByJKZ9pAa3qAogdpIVYgqEyWHJf8BvUXkVmhvhA/gKIA6L1szYJ34R/u4IbpvyGvjItiXf8p0h9x6XEHyNusE5PbrNdnX2XJDgorHr4s34zY9+raRc6ZHtTncd38+5zgN01sUDgta/LVifmuZX42kt8jnDgoYP/XcIac+mzqoiRw8cxsciqgr5Gz+jaBAZ8XI1UoitM0d5WHFKHvECQkRvExfXHl0LkgNJGXTeud7dRoQJRE7/kszRXvxvHBfmFh2R6PeuDn5ZlgY1+N4Q2KXUo3+cepLQbKwWbrHzwHqqcPwAUuEZVbuA==
  • Delivered-to: hono-dev@xxxxxxxxxxx
  • List-archive: <https://www.eclipse.org/mailman/private/hono-dev>
  • List-help: <mailto:hono-dev-request@eclipse.org?subject=help>
  • List-subscribe: <https://www.eclipse.org/mailman/listinfo/hono-dev>, <mailto:hono-dev-request@eclipse.org?subject=subscribe>
  • List-unsubscribe: <https://www.eclipse.org/mailman/options/hono-dev>, <mailto:hono-dev-request@eclipse.org?subject=unsubscribe>
  • Thread-index: AQHVyrDpolQ04QHFWkG8itsV69Loyg==
  • Thread-topic: [hono-dev] Definition of Hono's public API
  • User-agent: Microsoft-MacOutlook/10.20.0.191208
Hi Kai,

although I'm not part of the active Hono Development and barely a User I like how some projects use Annotations like @Experimental or @StableApi to signal their users which part of the interface is considered stable and which could change even with minor revisions.
For Example Apache Flink did that a lot (I don’t know if thei're still doing it).

And regarding your proposal, that sounds reasonable to me.

Julian

Am 14.01.20, 08:52 schrieb "hono-dev-bounces@xxxxxxxxxxx im Auftrag von Hudalla Kai (INST/ECS4)" <hono-dev-bounces@xxxxxxxxxxx im Auftrag von Kai.Hudalla@xxxxxxxx>:

    Hi list,
    
    with Hono 1.0.0 having been released last year, we now need to follow
    semantic versioning for its public API. So far so good. During the past
    weeks while implementing new features, we already ran in to situations
    where some refactoring would have been beneficial but where we had to
    think twice about whether we can simply change a method's signature or
    remove some obsolete class(es). I think we can all agree that this
    depends on whether the affected artifacts are to be considered part of
    Hono's public API or not.
    
    However, we haven't yet defined which parts of Hono actually constitute
    its public API. Thus, I would like to propose a draft of what I would
    consider (or like to see as) part of Hono's public API:
    
    1) All remote APIs documented under [1]
    2) All classes in the core module
    3) All classes in the client module
    4) All classes in the service-base module
    
    IMHO the rest would then automatically not be public API and would thus
    not be subject to semantic versioning.
    
    WDYT?
    
    [1] https://www.eclipse.org/hono/docs/api/
    
    -- 
    Mit freundlichen Grüßen / Best regards
    
    Kai Hudalla
    
    Software Developer - Bosch IoT Hub
    
    Bosch.IO GmbH
    Ullsteinstr. 128
    12109 Berlin
    GERMANY
    www.bosch.io
    
    Registered Office: Berlin, Registration Court: Amtsgericht
    Charlottenburg; HRB 148411 B
    Chairman of the Supervisory Board: Dr.-Ing. Thorsten Lücke;
    Managing Directors: Dr. Stefan Ferber, Dr. Aleksandar Mitrovic, Yvonne
    Reckling
    _______________________________________________
    hono-dev mailing list
    hono-dev@xxxxxxxxxxx
    To change your delivery options, retrieve your password, or unsubscribe from this list, visit
    https://www.eclipse.org/mailman/listinfo/hono-dev

Back to the top