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

Add swagger endpoints for Netlify Identity #344

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

NotWoods
Copy link

@NotWoods NotWoods commented Jun 8, 2021

Fixes #79

@NotWoods NotWoods requested review from a team as code owners June 8, 2021 03:12
@netlify
Copy link

netlify bot commented Jun 8, 2021

✔️ Deploy Preview for open-api ready!

🔨 Explore the source changes: 88b1481

🔍 Inspect the deploy log: https://app.netlify.com/sites/open-api/deploys/60c7906ec8dc100008d8d975

😎 Browse the preview: https://deploy-preview-344--open-api.netlify.app

Copy link

@rstavchansky rstavchansky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm getting a Page not found error when attempting to access the deploy preview.
I noticed that there don't seem to be updates to this section of the OpenAPI spec, and I would think it would need additions so that the Identity endpoints show up in docs output:

x-tagGroups:

@NotWoods NotWoods force-pushed the identity branch 2 times, most recently from cb38467 to 1456629 Compare June 8, 2021 18:27
@rstavchansky
Copy link

Thanks for the update @NotWoods. I see the output showing up now in the API reference docs.
I did want to note that the issue #79 also includes this:

We also need to add identity_instance_id to the payload of the site endpoint.

From a quick search, it looks like this would go within this object here:

site:

@bryanmikaelian bryanmikaelian added the type: chore work needed to keep the product and development running smoothly label Jun 9, 2021
@bryanmikaelian
Copy link

bryanmikaelian commented Jun 9, 2021

Changes are looking good to me too. Just a few errors I noticed when testing on https://editor.swagger.io/#

Semantic error at paths./sites/{site_id}/identity/{identity_instance_id}
Declared path parameter "site_id" needs to be defined as a path parameter at either the path or operation level
Jump to line 216
Semantic error at paths./sites/{site_id}/identity/{identity_instance_id}
Declared path parameter "identity_instance_id" needs to be defined as a path parameter at either the path or operation level
Jump to line 216
Semantic error at paths./sites/{site_id}/identity/{identity_instance_id}/users/{user_id}.put.parameters
Multiple body parameters are not allowed.
Jump to line 291
Structural error at paths./sites/{site_id}/identity/{identity_instance_id}/users.get.parameters.4
should have required property 'type'
missingProperty: type
Jump to line 244
Structural error at paths./sites/{site_id}/identity/{identity_instance_id}/users.get.parameters.5
should NOT have additional properties
additionalProperty: schema
Jump to line 248
Structural error at paths./sites/{site_id}/identity/{identity_instance_id}/users/{user_id}.delete.responses.200.schema.properties
should be object
Jump to line 361

@rstavchansky
Copy link

Thanks for adding identity_instance_id to the site body. I'll let @bryanmikaelian confirm the final details of the approval.

bryanmikaelian
bryanmikaelian previously approved these changes Jun 10, 2021
Copy link

@bryanmikaelian bryanmikaelian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ✨

@NotWoods
Copy link
Author

NotWoods commented Jul 1, 2021

bumping this discussion :) Are there any steps I need to take to help get this merged?

Copy link

@bryanmikaelian bryanmikaelian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@NotWoods 👍🏻 Sorry for the delay on the +1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: chore work needed to keep the product and development running smoothly
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Identity endpoints
3 participants