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.

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

chore: clean up and simplification #112

Closed
wants to merge 7 commits into from

Conversation

Sihamtahi
Copy link

Description

  • Delete _config.yaml, schema.json, package-lock.json and package.json files
  • Delete Test, extension/http and extension/sqs folders.
  • Create a md file for describing a twitter extension.

Related issue(s) #104

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Comment on lines +9 to +12
<a name="extensionId"></a>`id` | string | **Required**. Id of the extension.
<a name="extensionTitle"></a>`title` | string |**Required**. The title of the extension.
<a name="extensionDescription"></a>`description` |string| The description of the twitter extension.
<a name="extnesionPayload"></a>`payload` | Json Object |**Required**. A JSON object containing the detail of the twitter account.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<a name="extensionId"></a>`id` | string | **Required**. Id of the extension.
<a name="extensionTitle"></a>`title` | string |**Required**. The title of the extension.
<a name="extensionDescription"></a>`description` |string| The description of the twitter extension.
<a name="extnesionPayload"></a>`payload` | Json Object |**Required**. A JSON object containing the detail of the twitter account.
<a name="extensionId"></a>`id` | string | **Required**. Id of the extension.
<a name="extensionTitle"></a>`title` | string |**Required**. The title of the extension.
<a name="extensionDescription"></a>`description` |string| The description of the Twitter extension.
<a name="extensionPayload"></a>`payload` | Json Object |**Required**. A JSON object containing the detail of the Twitter account.

Comment on lines +9 to +12
<a name="extensionId"></a>`id` | string | **Required**. Id of the extension.
<a name="extensionTitle"></a>`title` | string |**Required**. The title of the extension.
<a name="extensionDescription"></a>`description` |string| The description of the twitter extension.
<a name="extnesionPayload"></a>`payload` | Json Object |**Required**. A JSON object containing the detail of the twitter account.
Copy link
Member

Choose a reason for hiding this comment

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

Why don't we simply merge this object with the payload one? We could just add schema and examples right into this object.

@derberg derberg changed the title chore : Cleaning up and simplifying repo chore: clean up and simplification Nov 16, 2022
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

@Samridhi-98 @fmvilas

looking at this PR and also comments from Fran, I think we need to clarify some stuff:

  • the idea is to have here the same approach as with bindings. So here in this repo we keep only markdown files, and schema goes to spec-json-schemas -> more info Extensions Catalog spec-json-schemas#280.
  • structure of markdown file should be as generic as possible IMHO, to make it easier to navigate through different extensions documentation and identify sections
  • I quickly drafted 👇🏼 what I mean
    Screenshot 2022-11-16 at 15 37 36

ah, and last but not least - the folder name where we describe the extension would be the id of the extension.

what do you folks think? there is basically no need for Twitter Object section.

I also quickly checked my proposal with #11

Screenshot 2022-11-16 at 15 36 33

Sihamtahi and others added 4 commits November 20, 2022 17:25
Co-authored-by: Fran Méndez <fmvilas@gmail.com>
Co-authored-by: Fran Méndez <fmvilas@gmail.com>
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@github-actions
Copy link

This pull request has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation.

There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Mar 21, 2023
@derberg
Copy link
Member

derberg commented Jul 11, 2023

closing in favour of #121

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants