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.

    Feature Released In
  • Dashboard
    • Most recent APIs v0.0.2
    • Links to project resources v0.0.2
    • Links to create/add APIs v0.0.2
  • Managing the list of APIs
    • List all APIs v0.0.2
    • Create a new API (empty) v0.0.2
    • Add an existing API v0.0.2
    • Remove an API from the Studio v0.0.2
    • API details (dashboard) v0.0.2
    • Show "Top Collaborators" information v0.0.2
  • API Designer
    • Add/remove paths (endpoints) v0.0.2
    • Add/remove Definitions (types) v0.0.2
    • Create new Definition from JSON sample v0.0.2
    • Inline editing of Name, Description, Version v0.0.2
    • Editing of Contact Info v0.0.5
    • Editing of License v0.0.4
    • Manage Tags v0.0.4
    • Manage Security Definitions v0.0.5
    • Configure available Operations for a path v0.0.2
    • Inline editing of Name, Description of Operation v0.0.2
    • Configure Operation's request body v0.0.2
    • Add/remove Operation query parameters v0.0.2
    • Add/remove Operation responses v0.0.2
    • Configure Operation's path parameters (description & type only) v0.0.2
    • Source tab support for Paths, Operations, Responses v0.0.4
    • Source tab support for Definitions v0.0.2
    • Configure Path Parameters for all Operations concurrently v0.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

Release Notes

v0.0.2 (Mar 06, 2017)
v0.0.3 (Mar 14, 2017)
v0.0.4 (Mar 21, 2017)
v0.0.5 (Apr 06, 2017)
v0.0.6 (Apr 25, 2017)
    Feature Released In
  • Managing the list of APIs
    • Filter by API tags (tags configured in the API Designer)
    • Audit logging (per API)
    • Optional commit API changes to branch rather than master
  • API Designer
    • Editing of Terms of Service
    • Editing server info (base URL, etc)
    • Editing Operation tags
    • Editing @produces, @consumes types on Operations
    • Design tab support for Definitions (constrained) v0.1.0
    • API validation against the OpenAPI specification v0.1.1
    • Support for re-usable Responses (Add, Remove, Reference)
    • Allow Endpoint-scoped path and query parameters v0.1.0
    • Allow overriding of path and query params at the Operation scope v0.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 access
    • Proper GitHub authentication Web Flow
    • Java based back-end implementation of REST API
    • Pluggable back-end persistence layer (default JDBC)
    • Supported platform - WildFly
    • Auditing of changes to API Designs

Release Notes

v0.1.0 (May 03, 2017)
v0.1.1 (May 12, 2017)
v0.1.2 (May 22, 2017)
v0.1.3 (May 24, 2017)
v0.1.4 (Jun 12, 2017)
v0.1.5 (Jun 15, 2017)
    Feature Released In
  • API Designer
    • Support for OpenAPI 3.0
    • Refactoring options (e.g. rename Definition)
    • Support for Undo/Redo (with UI)
    • Add "Find Usages" functionality (e.g. find all usages of a Definition)
    • Concurrent editing of API definitions
    • Improved/enhanced Schema (definition) editing
  • Back-End
    • Support for alternative source code repositories and types (e.g. Gitlab)
    • Websocket based API to concurrently edit API definitions
    • At least one alternative persistence layer (e.g. Elasticsearch)
  • Integration
    • Integrate with 3scale platform (bootstrap API management config)
    • Integrate with openshift.io

Release Notes

    Feature Released In
  • API Studio
    • Mocking/testing of API Designs
    • Generate API documentation
    • Bootstrap API implementation project
  • API Designer
    • Resource-first design options
  • Back-End
    • Support for alternative source code repositories and types (e.g. Gitlab)
    • Websocket based API to concurrently edit API definitions
    • At least one alternative persistence layer (e.g. Elasticsearch)
  • Integration
    • Integrate with syndesis
    • Integrate with jBPM
    • Integrate with Teiid

Release Notes