Apicurio Studio Roadmap

Here you will find a very high level roadmap for the Apicurio Studio project. The details are subject to change, but this page can provide a basic sense of the project's priorities and releases. Additional information can typically be found on GitHub.

The intention is to release new versions of the Apicurio Studio very frequently. This roadmap represents a high level set of features that make up a given release series (for example, Beta. The list of tasks for each release series is an indication of the work to be done in that series, but not an implication of the order in which that work will be done. Finally, we will not wait until all of the tasks are complete, but will instead release iteratively as soon as useful functionality is completed.

[released]

    Feature Released In
  • Dashboard
    • Most recent APIsv0.0.2
    • Links to project resourcesv0.0.2
    • Links to create/add APIsv0.0.2
  • Managing the list of APIs
    • List all APIsv0.0.2
    • Create a new API (empty)v0.0.2
    • Add an existing APIv0.0.2
    • Remove an API from the Studiov0.0.2
    • API details (dashboard)v0.0.2
    • Show "Top Collaborators" informationv0.0.2
  • API Designer
    • Add/remove paths (endpoints)v0.0.2
    • Add/remove Definitions (types)v0.0.2
    • Create new Definition from JSON samplev0.0.2
    • Inline editing of Name, Description, Versionv0.0.2
    • Editing of Contact Infov0.0.5
    • Editing of Licensev0.0.4
    • Manage Tagsv0.0.4
    • Manage Security Definitionsv0.0.5
    • Configure available Operations for a pathv0.0.2
    • Inline editing of Name, Description of Operationv0.0.2
    • Configure Operation's request bodyv0.0.2
    • Add/remove Operation query parametersv0.0.2
    • Add/remove Operation responsesv0.0.2
    • Configure Operation's path parameters (description & type only)v0.0.2
    • Source tab support for Paths, Operations, Responsesv0.0.4
    • Source tab support for Definitionsv0.0.2
    • Configure Path Parameters for all Operations concurrentlyv0.0.5
    • Support for more inline Type options (e.g. Array of...)v0.0.5
  • Back-End
    • Use GitHub directly (for authentication and i/o)v0.0.2

[released]

    Feature Released In
  • Managing the list of APIs
    • Filter by API tags (tags configured in the API Designer)v0.1.11
  • API Designer
    • Support for OpenAPI 3.0v0.1.10
    • Design tab support for Definitions (constrained)v0.1.0
    • API validation against the OpenAPI specificationv0.1.1
    • Allow Endpoint-scoped path and query parametersv0.1.0
    • Allow overriding of path and query params at the Operation scopev0.1.0
    • Support for YAML in Source tabs (optionally and in addition to JSON)v0.1.4
  • Back-End
    • Back-end REST API instead of direct GitHub accessv0.1.6
    • Proper GitHub authentication Web Flowv0.1.6
    • Java based back-end implementation of REST APIv0.1.6
    • Supported platform - WildFlyv0.1.6
    • Supported platform - Fabric8/Kubernetes (WildFly Swarm based)v0.1.11
    • Support for Keycloak as the authentication providerv0.1.8
    • Support for Linked Accounts (e.g. GitHub, GitLab, Bitbucket)v0.1.8
    • Linked Account - GitHubv0.1.8
    • Linked Account - GitLabv0.1.11
    • Linked Account - Bitbucketv0.1.11

Beta 2(current release series)

    Feature Released In
  • Managing the list of APIs
    • Audit logging (per API)v0.2.3
  • API Designer
    • Concurrent editing of API definitionsv0.2.2
    • Support for re-usable Responses (Add, Remove, Reference)v0.2.31
    • Allow editing of request/response payload examplesv0.2.5
    • Refactoring options (e.g. rename Definition)v0.2.5
    • Add "Find Usages" functionality (e.g. find all usages of a Definition)
    • Editing OperationIDsv0.2.6
    • Editing server info (base URL, etc)v0.2.2
    • Editing Security Requirementsv0.2.6
    • Editing @produces, @consumes types on Operationsv0.2.15
    • Validation error/warning icons integrated in-context in the UIv0.2.12
    • Full undo/redo support in the editorv0.2.14
    • Markdown support for all Description fieldsv0.2.15
    • Resource-first design optionsv0.2.15
    • Preview API Documentation (using ReDoc)v0.2.22
  • Back-End
    • Auditing of changes to API Designsv0.2.3
    • Websocket based API to concurrently edit API definitionsv0.2.0
    • Support for alternative source code repositories and types (e.g. Gitlab)v0.2.13
    • Add Project and Team concepts
    • Support Team permissions on Projects and APIs
    • Support multiple Versions of each API
    • Generate implementation project from API Designv0.2.11
    • Scalable JMS based editing layerv0.2.25
  • API Hub
    • Create API Hub to host all finalized APIs
    • Create Hub UI to browse finalized APIs

    Feature Released In
  • API Studio
    • Mocking/testing of API Designs
    • Generate API documentation
  • Back-End
    • Pluggable back-end persistence layer (default JDBC)
    • At least one alternative persistence layer (e.g. Elasticsearch)
  • Integration
    • Integrate with syndesis
    • Integrate with jBPM
    • Integrate with Teiid