Revert "Added asynchronous API guidelines content" #73
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -66,35 +66,5 @@ | |||
|
|
|||
| ## Asynchronous API Guidelines | |||
|
|
|||
| * [Introduction to guidelines](asynchronous-api-guidelines/01_introduction/a_introduction.md) | |||
There was a problem hiding this comment.
Only "Introduction" aligned with other sections
| * [Introduction to guidelines](asynchronous-api-guidelines/01_introduction/a_introduction.md) | ||
| * 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) |
| * [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) | ||
| * [Events](asynchronous-api-guidelines/01_introduction/d_basic_concepts_events.md) | ||
| * Asynchronous API Guidelines |
| * [Basic terminology](asynchronous-api-guidelines/01_introduction/c_basic_concepts_terminology.md) | ||
| * [Events](asynchronous-api-guidelines/01_introduction/d_basic_concepts_events.md) | ||
| * Asynchronous API Guidelines | ||
| * [Contract](asynchronous-api-guidelines/02_asynchronous_api_guidelines/a_contract.md) |
There was a problem hiding this comment.
We could delete this section, duplicated in General Guidelines
| * [Events](asynchronous-api-guidelines/01_introduction/d_basic_concepts_events.md) | ||
| * Asynchronous API Guidelines | ||
| * [Contract](asynchronous-api-guidelines/02_asynchronous_api_guidelines/a_contract.md) | ||
| * [API First](asynchronous-api-guidelines/02_asynchronous_api_guidelines/b_api_first.md) |
There was a problem hiding this comment.
We could delete this section, duplicated in General Guidelines
| * Asynchronous API Guidelines | ||
| * [Contract](asynchronous-api-guidelines/02_asynchronous_api_guidelines/a_contract.md) | ||
| * [API First](asynchronous-api-guidelines/02_asynchronous_api_guidelines/b_api_first.md) | ||
| * [Immutability](asynchronous-api-guidelines/02_asynchronous_api_guidelines/c_immutability.md) |
There was a problem hiding this comment.
We could move this section to General Guidelines
| * [Contract](asynchronous-api-guidelines/02_asynchronous_api_guidelines/a_contract.md) | ||
| * [API First](asynchronous-api-guidelines/02_asynchronous_api_guidelines/b_api_first.md) | ||
| * [Immutability](asynchronous-api-guidelines/02_asynchronous_api_guidelines/c_immutability.md) | ||
| * [Common Data Types](asynchronous-api-guidelines/02_asynchronous_api_guidelines/d_data_types.md) |
There was a problem hiding this comment.
We could move this section to General Guidelines
| * [API First](asynchronous-api-guidelines/02_asynchronous_api_guidelines/b_api_first.md) | ||
| * [Immutability](asynchronous-api-guidelines/02_asynchronous_api_guidelines/c_immutability.md) | ||
| * [Common Data Types](asynchronous-api-guidelines/02_asynchronous_api_guidelines/d_data_types.md) | ||
| * [Automatic Schema Registration](asynchronous-api-guidelines/02_asynchronous_api_guidelines/e_schema_registration.md) |
There was a problem hiding this comment.
Maybe this section should move to Kafka guidelines
|
This revert, can be closed. |
|
Changes merged in #71 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reverts #71
Re-arrange structure to avoid redundances of section naming in headers' levels
Re-distribute sections meaning to general topics (e.g. Immutability) to General Guidelines.
Remove section redundant with already existing ones in General (e.g. API First).
Move sections 100% related to Kafka to Kafka guidelines section.
Avoid contractions.
Add uppercase in headers.