Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SailPoint IIQ API Specification invalid #48

Open
yilmi opened this issue Dec 19, 2023 · 3 comments
Open

SailPoint IIQ API Specification invalid #48

yilmi opened this issue Dec 19, 2023 · 3 comments

Comments

@yilmi
Copy link

yilmi commented Dec 19, 2023

The current SailPoint IIQ Specification doesn't follow the OpenAPI Specification. As such, it can't be used to generate clients using the OpenAPI Generator CLI or the Swagger CodeGen CLI.

I went through the different validation errors to fix the specification and to generate a valid client for my use cases.

I assumed SailPoint was taking an API first approach and started preparing a version of the specification that works to submit it as a pull request - https://github.com/thomsonreuters/sailpoint-api-specs/blob/sailpoint-iiq-spec-fix/iiq/sailpoint-api.iiq.yaml

But reading your readme after, I understand these specification are generated automatically from code and not the opposite.

The OpenAPI Specification describes this requirement here - https://spec.openapis.org/oas/v3.0.3#properties

items - Value MUST be an object and not an array. Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema. items MUST be present if the type is array.

Could you regenerate a specification that passes the validation from the openapi-generator and Swagger CodeGen tool?

@colin-mckibben-sp
Copy link
Contributor

Hi @yilmi . You are correct that we do not accept direct contributions to our API specs as they are maintained internally. However, can you open a PR with your changes so we can see the exact modifications you made? This will help us know what to fix.

@yilmi
Copy link
Author

yilmi commented Jan 5, 2024

Hi @colin-mckibben-sp - sorry for the delay, I opened a PR #49 - the issue is that the file I had also contains a lot of other changes coming from a yaml linter I ran.

I'll share a version that only has the meaningful changes next week

@yilmi
Copy link
Author

yilmi commented Jan 16, 2024

Hey @colin-mckibben-sp, I found some time to update the PR, you should only see relevant changes now, I separated components validation fixes and paths validation fixes in two separate commits. Thanks!

developer-relations-sp added a commit that referenced this issue Oct 11, 2024
NEROCKET-1747 fixing filters being listed as an object.' by github action: 11292781914
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants