Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Revert "Added asynchronous API guidelines content" #73

Closed
wants to merge 1 commit into from
Closed

Revert "Added asynchronous API guidelines content" #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The API Guidelines are split into two main parts:
* [General Guidelines](general-guidelines/general-guidelines.md)
* API type-specific Guidelines
* [REST APIs Guidelines](rest-api-guidelines/rest.md)
* [Asynchronous APIs Guidelines](asynchronous-api-guidelines/index.md)
* [Asynchronous APIs Guidelines](asynchronous-api-guidelines/asyncapi.md)

The general guidelines section discusses the core principles relevant to any kind of API. The API type-specific section further defines the guidelines specific to a given architectural style or API technique \(such as REST, Kafka or GraphQL APIs\).

Expand Down
34 changes: 2 additions & 32 deletions SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,35 +66,5 @@

## Asynchronous API Guidelines

* [Introduction to guidelines](asynchronous-api-guidelines/01_introduction/a_introduction.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only "Introduction" aligned with other sections

* Basic Concepts
* [Event Driven Architectures](asynchronous-api-guidelines/01_introduction/b_basic_concepts_edas.md)
* [Basic terminology](asynchronous-api-guidelines/01_introduction/c_basic_concepts_terminology.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basic Terminology

* [Events](asynchronous-api-guidelines/01_introduction/d_basic_concepts_events.md)
* Asynchronous API Guidelines
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Core Principles

* [Contract](asynchronous-api-guidelines/02_asynchronous_api_guidelines/a_contract.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could delete this section, duplicated in General Guidelines

* [API First](asynchronous-api-guidelines/02_asynchronous_api_guidelines/b_api_first.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could delete this section, duplicated in General Guidelines

* [Immutability](asynchronous-api-guidelines/02_asynchronous_api_guidelines/c_immutability.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could move this section to General Guidelines

* [Common Data Types](asynchronous-api-guidelines/02_asynchronous_api_guidelines/d_data_types.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could move this section to General Guidelines

* [Automatic Schema Registration](asynchronous-api-guidelines/02_asynchronous_api_guidelines/e_schema_registration.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this section should move to Kafka guidelines

* [Schema Data Evolution](asynchronous-api-guidelines/02_asynchronous_api_guidelines/f_schema_data_evolution.md)
* [Key/Value format](asynchronous-api-guidelines/02_asynchronous_api_guidelines/g_key_value_format.md)
* [Message Headers](asynchronous-api-guidelines/02_asynchronous_api_guidelines/h_message_headers.md)
* [Naming Conventions](asynchronous-api-guidelines/02_asynchronous_api_guidelines/i_naming_conventions.md)
* [Protocols](asynchronous-api-guidelines/02_asynchronous_api_guidelines/j_protocols.md)
* [Security](asynchronous-api-guidelines/02_asynchronous_api_guidelines/k_security.md)
* AsyncAPI specs for Kafka
* [Introduction](asynchronous-api-guidelines/03_asyncapi_kafka_specs/a_introduction.md)
* [AsyncAPI version](asynchronous-api-guidelines/03_asyncapi_kafka_specs/b_asyncapi_version.md)
* [Internal vs Public specs](asynchronous-api-guidelines/03_asyncapi_kafka_specs/c_internal_public_specs.md)
* [Spec granularity](asynchronous-api-guidelines/03_asyncapi_kafka_specs/d_spec_granularity.md)
* [Meaningful descriptions](asynchronous-api-guidelines/03_asyncapi_kafka_specs/e_meaningful_descriptions.md)
* [Self-contained specs](asynchronous-api-guidelines/03_asyncapi_kafka_specs/f_self_contained_specs.md)
* [Contact Information](asynchronous-api-guidelines/03_asyncapi_kafka_specs/g_contact_information.md)
* [AsyncAPI ID](asynchronous-api-guidelines/03_asyncapi_kafka_specs/h_asyncapi_id.md)
* [Servers](asynchronous-api-guidelines/03_asyncapi_kafka_specs/i_servers.md)
* [Channels](asynchronous-api-guidelines/03_asyncapi_kafka_specs/j_channels.md)
* [Schemas](asynchronous-api-guidelines/03_asyncapi_kafka_specs/k_schemas.md)
* [Security Schemes](asynchronous-api-guidelines/03_asyncapi_kafka_specs/l_security_schemes.md)
* [External Docs](asynchronous-api-guidelines/03_asyncapi_kafka_specs/m_external_docs.md)
* [Tooling](asynchronous-api-guidelines/03_asyncapi_kafka_specs/n_tooling.md)
* [Introduction](asynchronous-api-guidelines/asyncapi.md)

Binary file removed assets/eda_overview.png
View file
Open in desktop
Binary file not shown.
Binary file removed assets/eda_problem_statement_1.png
View file
Open in desktop
Binary file not shown.
Binary file removed assets/eda_problem_statement_2.png
View file
Open in desktop
Binary file not shown.
Binary file removed assets/sr_backward_compatibility.png
View file
Open in desktop
Binary file not shown.
Binary file removed assets/sr_forward_compat.png
View file
Open in desktop
Binary file not shown.
Binary file removed assets/sr_full_compat.png
View file
Open in desktop
Binary file not shown.
22 changes: 0 additions & 22 deletions asynchronous-api-guidelines/01_introduction/a_introduction.md
View file
Open in desktop

This file was deleted.

73 changes: 0 additions & 73 deletions asynchronous-api-guidelines/01_introduction/b_basic_concepts_edas.md
View file
Open in desktop

This file was deleted.

72 changes: 0 additions & 72 deletions asynchronous-api-guidelines/01_introduction/c_basic_concepts_terminology.md
View file
Open in desktop

This file was deleted.

31 changes: 0 additions & 31 deletions asynchronous-api-guidelines/01_introduction/d_basic_concepts_events.md
View file
Open in desktop

This file was deleted.

9 changes: 0 additions & 9 deletions asynchronous-api-guidelines/02_asynchronous_api_guidelines/a_contract.md
View file
Open in desktop

This file was deleted.

10 changes: 0 additions & 10 deletions asynchronous-api-guidelines/02_asynchronous_api_guidelines/b_api_first.md
View file
Open in desktop

This file was deleted.

9 changes: 0 additions & 9 deletions asynchronous-api-guidelines/02_asynchronous_api_guidelines/c_immutability.md
View file
Open in desktop

This file was deleted.

18 changes: 0 additions & 18 deletions asynchronous-api-guidelines/02_asynchronous_api_guidelines/d_data_types.md
View file
Open in desktop

This file was deleted.

7 changes: 0 additions & 7 deletions ...chronous-api-guidelines/02_asynchronous_api_guidelines/e_schema_registration.md
View file
Open in desktop

This file was deleted.

Loading