Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.98 KB

README.md

File metadata and controls

36 lines (25 loc) · 1.98 KB
Raw

symphony-api-spec

This repository will contain the Swagger API definition files for the Symphony REST API. These files were previously available from Symphony LLC at https://rest-api.symphony.com/docs/rest-api-specification. Versions of these files prior to release 1.46 can still be found there.

Branching and versioning of this repository will match those of the Symphony platform:

  • Branches: rc-current-r46, rc-current-r47, etc.
  • Versions: 1.46.0, 1.46.1, 1.47.0, etc.

There are three sets of definition files (authenticator, 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.

You can paste the contents of these files into Swagger Editor, from which you can generate client code.

Contributing

  1. Fork it (https://github.com/symphonyoss/symphony-api-spec/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Read our contribution guidelines and Community Code of Conduct
  4. Commit your changes (git commit -am 'Add some fooBar')
  5. Push to the branch (git push origin feature/fooBar)
  6. Create a new Pull Request

Validating your changes (requires Maven)

You can verify that your contribution is valid by simply running :

mvn clean package

This 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.

License

The code in this repository is distributed under the Apache License, Version 2.0.

Copyright (c) 2020 Symphony LLC