Skip to content

Explicit public surface definition #1533

Open
@sobolk

Description

@sobolk

We should define and document our public contract. So that customers know how our public surface is evolved and for us to guide that evolution.

We should define and publish:

  1. What API changes are allowed in what package.
  2. How do we mark APIs as public, "public but for internal purpose", experimental etc.
  3. Which stateful parts, like deployed resources are considered contract and which not. For example, CFN outputs.

In addition, we should implement automated checks to enforce that publicly facing elements are properly documented and annotated.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationfeature-requestNew feature or requesttech-debtRefactors, unsavory workarounds or other technical decisions that should be revisited later

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions