FOSS Foundations Info

Foundation

getFoundationById

Get Foundation by exact lowercase string identifier.

Returns a single Foundation organizational model object for an exact identifier.


/_foundations/{foundationId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://raw.githubusercontent.com/Punderthings/fossfoundation/main/_foundations/{foundationId}.md"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FoundationApi;

import java.io.File;
import java.util.*;

public class FoundationApiExample {

    public static void main(String[] args) {
        
        FoundationApi apiInstance = new FoundationApi();
        String foundationId = foundationId_example; // String | Identifier of Foundation object to return; lowercase alpha string.
        try {
            Foundation result = apiInstance.getFoundationById(foundationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FoundationApi#getFoundationById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FoundationApi;

public class FoundationApiExample {

    public static void main(String[] args) {
        FoundationApi apiInstance = new FoundationApi();
        String foundationId = foundationId_example; // String | Identifier of Foundation object to return; lowercase alpha string.
        try {
            Foundation result = apiInstance.getFoundationById(foundationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FoundationApi#getFoundationById");
            e.printStackTrace();
        }
    }
}
String *foundationId = foundationId_example; // Identifier of Foundation object to return; lowercase alpha string.

FoundationApi *apiInstance = [[FoundationApi alloc] init];

// Get Foundation by exact lowercase string identifier.
[apiInstance getFoundationByIdWith:foundationId
              completionHandler: ^(Foundation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var FossFoundationsInfo = require('foss_foundations_info');

var api = new FossFoundationsInfo.FoundationApi()
var foundationId = foundationId_example; // {{String}} Identifier of Foundation object to return; lowercase alpha string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFoundationById(foundationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFoundationByIdExample
    {
        public void main()
        {

            var apiInstance = new FoundationApi();
            var foundationId = foundationId_example;  // String | Identifier of Foundation object to return; lowercase alpha string.

            try
            {
                // Get Foundation by exact lowercase string identifier.
                Foundation result = apiInstance.getFoundationById(foundationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FoundationApi.getFoundationById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiFoundationApi();
$foundationId = foundationId_example; // String | Identifier of Foundation object to return; lowercase alpha string.

try {
    $result = $api_instance->getFoundationById($foundationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FoundationApi->getFoundationById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FoundationApi;

my $api_instance = WWW::SwaggerClient::FoundationApi->new();
my $foundationId = foundationId_example; # String | Identifier of Foundation object to return; lowercase alpha string.

eval { 
    my $result = $api_instance->getFoundationById(foundationId => $foundationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FoundationApi->getFoundationById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FoundationApi()
foundationId = foundationId_example # String | Identifier of Foundation object to return; lowercase alpha string.

try: 
    # Get Foundation by exact lowercase string identifier.
    api_response = api_instance.get_foundation_by_id(foundationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FoundationApi->getFoundationById: %s\n" % e)

Parameters

Path parameters
Name Description
foundationId*
String
Identifier of Foundation object to return; lowercase alpha string.
Required

Responses

Status: 200 - Successful operation; Foundation object returned.

Status: 400 - Invalid ID: does not map to existing Foundation

Status: 404 - Not Found ID: does not map to existing Foundation


getFoundations

Get list of available Foundation identifiers as lowercase strings.

Returns list of all valid identifiers, along with aliasOf values to map common names like 'org.apache' to 'asf'.


/_foundations/list.json

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://raw.githubusercontent.com/Punderthings/fossfoundation/main/_foundations/list.json"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FoundationApi;

import java.io.File;
import java.util.*;

public class FoundationApiExample {

    public static void main(String[] args) {
        
        FoundationApi apiInstance = new FoundationApi();
        try {
            FoundationList result = apiInstance.getFoundations();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FoundationApi#getFoundations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FoundationApi;

public class FoundationApiExample {

    public static void main(String[] args) {
        FoundationApi apiInstance = new FoundationApi();
        try {
            FoundationList result = apiInstance.getFoundations();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FoundationApi#getFoundations");
            e.printStackTrace();
        }
    }
}

FoundationApi *apiInstance = [[FoundationApi alloc] init];

// Get list of available Foundation identifiers as lowercase strings.
[apiInstance getFoundationsWithCompletionHandler: 
              ^(FoundationList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var FossFoundationsInfo = require('foss_foundations_info');

var api = new FossFoundationsInfo.FoundationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFoundations(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFoundationsExample
    {
        public void main()
        {

            var apiInstance = new FoundationApi();

            try
            {
                // Get list of available Foundation identifiers as lowercase strings.
                FoundationList result = apiInstance.getFoundations();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FoundationApi.getFoundations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiFoundationApi();

try {
    $result = $api_instance->getFoundations();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FoundationApi->getFoundations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FoundationApi;

my $api_instance = WWW::SwaggerClient::FoundationApi->new();

eval { 
    my $result = $api_instance->getFoundations();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FoundationApi->getFoundations: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FoundationApi()

try: 
    # Get list of available Foundation identifiers as lowercase strings.
    api_response = api_instance.get_foundations()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FoundationApi->getFoundations: %s\n" % e)

Parameters

Responses

Status: 200 - Successful operation; list returned.