Issue: Swagger Operation IDs
Published
In the next release, we will implement new operation ID values in the OpenApi (fka Swagger) definitions for several SKY APIs. This change will improve client-side tooling support for code generation by making these values more deterministic and friendlier across different languages. Going forward, we expect high stability of these values (meaning, we won’t need to change them again).
Note that any existing code that has been deployed will continue to function with no problems, since we are not changing any routes or parameters. If you make use of client-side generated code and want to regenerate your client wrapper, you’ll need to fix any compile-time errors in your code stemming from new method names.
This change will be rolled out to the Constituent, Fundraising (Beta), Gift (Beta), and Opportunity (Beta) APIs. The change will also affect the URLs for our endpoint reference.
Note that any existing code that has been deployed will continue to function with no problems, since we are not changing any routes or parameters. If you make use of client-side generated code and want to regenerate your client wrapper, you’ll need to fix any compile-time errors in your code stemming from new method names.
This change will be rolled out to the Constituent, Fundraising (Beta), Gift (Beta), and Opportunity (Beta) APIs. The change will also affect the URLs for our endpoint reference.
News
SKY Developer Announcements
05/25/2018 2:24pm EDT
Leave a Comment