Split up the twitter-api-spec.yml file

SimonHoiberg commented 4 years ago

Currently

The Twitter API Client is generated based on one single twitter-api-spec.yml file which is currently a whopping 3000+ lines long. It's really cumbersome to scroll around in that file to find what you want.

Desired

The twitter-api-spec.yml file is split up into multiple .yml files. One for each group.

AC

The folder src/spec/ is renamed to src/specs/ and all references in the generator files are changed.
The file twitter-api-spec.yml is split up into multiple files.

Additional notes

To begin with, I think it would be great to have one for each group.
A file src/specs/basics.yml, a file src/specs/accounts-and-users.yml, a file src/specs/tweets.yml, etc.
The file twitter-api-spec.yml should still be the main spec file that references these other files.

SimonHoiberg commented 4 years ago

This task is up for grabs during Hacktoberfest :raised_hands:

If you want to work on this task, please claim it here in the comments. Feel free to ask any questions here as well :blush:

DipanjanDasIT commented 4 years ago

I am wiling to work on this.

SimonHoiberg commented 4 years ago

Hi @DipanjanDasIT That sounds awesome! I'll assign you right away :smile:

DipanjanDasIT commented 4 years ago

@Silind can we change the spec file format from yaml to RAML?

iliran11 commented 4 years ago

Can you please stick to YAML format?

SimonHoiberg commented 4 years ago

Yes, let's stick to YAML format. The change will be too comprehensive at this moment.

FeedHive / twitter-api-client