wso2 / wso2/api-platform

Pull APIs into the API Platform from remote Git repositories

Open
#127 0 comments 0 reactions 2 assignees View on GitHub

Nobody has claimed this yet.

Type/Parent Type/Task
Dominant language
Go
Stars
71
Forks
111
Avg merge
1d 14h
Merged PRs (30d)
110

Description

Description
Description

The goal of this feature is to enable users to import (pull) API artifacts from remote Git repositories into the API Platform to easily create and manage APIs designed externally.

User Story

As a user,
I want to pull API projects from a remote Git repository (public or private)
so that I can import APIs designed using the API Designer into the API Platform without manually uploading files.

Users can design APIs locally using the API Designer, where each project is identified by a .api-platform folder.
This folder contains:

config.yaml – defines project configuration, including references to OpenAPI and API definition files

The API project contains

  • openapi.yaml – the OpenAPI specification of the API
  • api.yaml – the API definition file
  • API Documentation
  • Certificates

Once designed, the project can be pushed to a remote Git repository (public or private).
The API Platform will then support pulling these API projects directly from the repository to create an API.

Flow
  1. Select Repository Source
  • Option 1: Public repository
  • Option 2: Private repository
  1. Provide Repository URL
  • The user enters the Git repository URL.
  1. Fetch Repository Details
  • The platform lists available branches in the repository.
  • Once a branch is selected, the platform displays the directory structure.
  1. Select API Project Directory
  • The user selects a directory path that should contain the .api-platform folder.
  • If the selected directory does not contain a valid .api-platform folder (with required files), show a validation error.
  1. Pull API Artifacts
  • If valid, pull the following artifacts:
    • openapi.yaml
    • api.yaml
  • Additional assets such as documentation files and certificates.
  1. Populate API Creation Form
  • Use the pulled details to pre-fill the API creation form in the platform.
  • Display API metadata and available resources for review before creation.

Acceptance Criteria

  • Ability to pull from public Git repositories
  • Ability to pull from private Git repositories (with authentication if needed)
  • Lists branches and directory structure for the selected repo
  • Validates presence and structure of .api-platform folder
  • Successfully imports openapi.yaml, api.yaml, and related assets
  • Populates API creation form with fetched data
  • Displays validation or error messages when applicable

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.