techdocs icon indicating copy to clipboard operation
techdocs copied to clipboard

Concerto API documentation

Open jeromesimeon opened this issue 3 years ago • 2 comments

Description

I'm unclear what follows is merely a question or an issue:

I think the "functional API" for concerto is only available as an experimental feature in 1.0.0-alpha at the moment (possibly in 1.0.0 or later by the time anyone will be reading this).

But the documentation seems to point to it as available as part of the main release: https://docs.accordproject.org/docs/model-api.html

I worry this might confuse some of our users.

jeromesimeon avatar Mar 19 '21 18:03 jeromesimeon

I think the "functional API" for concerto is only available as an experimental feature in 1.0.0-alpha at the moment

As you had said here so maybe we can add some similar text like "Functional API (experimental)" which will indicate to the user that the API is still in the experimental stage. We can also give the reference to the release description we are having for that Functional API (experimental) here ( https://github.com/accordproject/concerto/releases/tag/v1.0.0-alpha.2 )

Aniruddha-Shriwant avatar Mar 20 '21 06:03 Aniruddha-Shriwant

I would like to work on this issue, kindly assign

poojatalele avatar Jul 21 '24 07:07 poojatalele