ForgedFed Discovery Service (0.1.0)

Download OpenAPI specification:Download

ForgedFed Developers: forgedfed@gmail.com License: AGPL3

This service is used to discover bridge interfaces that operate on forges. More information about this can be found on GitHub

interface

A bridge component that talks the bridge protocol and is able to affect changes to the forge that it manages.

Add an interface to the discovery service

A forge can have multiple interfaces. North Star is used to map relationships between a forge and the interfaces that operate on it, acting like a telephone direcory. This endpoint is used to register an interface against a forge in North Star

Request Body schema: application/json

Interface object that needs to be added to the discovery service

interface_url
string

The publicly accessible URL of the bridge interface

forge_url
Array of strings

The publicly accessible URL of the forge that this interface manages. If a forge is known by more than one URL(separate bug tracker, and different fetch and push URLs for git), then mention them all in this field

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "errcode": "F_D_EMPTY_FORGE_LIST",
  • "error": "The forge list submited is empty. An interface should handle at least one forge."
}

Get all interfaces registered against a forge

To setup a bridge, an interface that can talk to the target forge must be identified. North Star is a lookup service that makes this possible. This endpoint is used to get all interfaces registered the queried forge

Request Body schema: application/json

Forge URL

forge_url
string

The publicly accessible URL of the bridge interface

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json