Solution structure

The solution structure corresponds to that of the GitHub API reference menu structure to aid findability between the two.

Each menu item on the left of the API Documentation page has its own separate folder in the 'GitHub' project in the Linx Solution.

So for example, functionality related to the Repos API and the Users API are grouped into separate folders like below:

Solution
└── GitHub
    ├── Repos
    └── Users

Each of these folders then contains separate folders for each of the sub-sections on the GitHub API reference page on the right side menu.

In the case of the 'Repos API' - the sub-sections 'Commits' and 'Community' on the API reference right menu, will each get their own folder in the 'Repos' folder in the Linx Solution.

Solution
└── GitHub
    ├── Repos
    |   ├── Commits
    |   └── Community
    └── Users

Inside each of these folders then contains 2 sub-folders which are:

• Requests: Connector functions which execute a HTTP request and process the response.
• Types: Objects used for de-serializing the inputs and outputs of the functions.

For example. the 'list commits' method, it is nested under the 'Commits' section and therefore will take the below structure.

Solution
└── GitHub
    └── Repos
        └── Commits
            ├── Requests
            |   ├─ ListCommits 
            |   └─ GetACommit
            └── Types

In the case of 'List organization repositories' , the method is on the parent level of the Repositories API and therefore it will be nested in a sub-folder with the same name as the parent section.

Solution
└── GitHub
    └── Repos
        ├── Commits
        |   └── Requests
        |       ├─ ListCommits 
        |       └─ GetACommit
        └── Repos
            └── Requests
                ├─ ListOrganizationRepostories 
                └─ GetARepository