This repository contains the Swagger (2.0) API definition files for the Symphony REST API. The full documentation of the API is available on the developer's website.
Branches and releases of this repository will match those of the Symphony platform (20.10, 20.12,...).
There are three sets of definition files (login, agent and pod) and each set has two files: a "-public" file which contains all the current endpoint definitions, and a "-public-deprecated" file which contains all the current and the all the deprecated endpoint definitions.
A Postman collection is provided to help you test the API. You can paste the definition files into Swagger Editor, from which you can generate client code.
The definition files are automatically updated after each Symphony release so we don't usually expect those to be manually edited. However, it can be useful to open a PR to suggest documentation changes.
- Fork it (https://github.com/finos/symphony-api-spec/fork)
- Create your feature branch (
git checkout -b feature/fooBar) - Read our contribution guidelines and Community Code of Conduct
- Commit your changes (
git commit -am 'Add some fooBar') - Push to the branch (
git push origin feature/fooBar) - Create a new Pull Request
NOTE: Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool. Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.
Need an ICLA? Unsure if you are covered under an existing CCLA? Email [email protected]
You can verify that your contribution is valid by simply running :
mvn clean packageThis will execute
the openapi-generator-maven-plugin
in order to generate a Java client from the API specifications. If BUILD SUCCESS, it means that
your additions are valid !
If BUILD FAILURE, check the command output where the validation error has been described.
Copyright 2021 Symphony LLC
Distributed under the Apache License, Version 2.0.
SPDX-License-Identifier: Apache-2.0