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

fix: remove session endpoints and fix server drop-down #118

Merged
merged 4 commits into from
Jan 18, 2024

Conversation

acuarica
Copy link
Contributor

@acuarica acuarica commented Jan 10, 2024

Description:

Remove session endpoints so that we can share the api-docs. Also fix the server drop-down which was showing always the local dev server.

I have included both prod and local server in the drop-down, but maybe the Current REST API server suffices.

Default server value

image

When the user opens the servers drop-down

image

Session endpoints label

image

Related issue(s):

Fixes #

Notes for reviewer:

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

@acuarica acuarica linked an issue Jan 10, 2024 that may be closed by this pull request
2 tasks
@acuarica acuarica changed the title Remove session endpoints and fix server drop-down fix: remove session endpoints and fix server drop-down Jan 10, 2024
@acuarica acuarica marked this pull request as ready for review January 11, 2024 17:40
@acuarica acuarica requested review from a team as code owners January 11, 2024 17:40
@acuarica acuarica requested review from quiet-node, Sheng-Long and Reccetech and removed request for a team January 11, 2024 17:40
@svienot
Copy link
Contributor

svienot commented Jan 11, 2024

If we do not remove the Session API endpoints from the spec, we might want to give a stronger warning than “not supported”. In fact no client code running in a browser is ever going to be able to call these endpoints (unless the corresponding domain is configured as an allowedOrigin in the server session).

Other than that, looks good to me.

Signed-off-by: Luis Mastrangelo <[email protected]>
@acuarica
Copy link
Contributor Author

@Nana-EC @svienot I've updated the message, pls take a look.

Copy link
Collaborator

@Nana-EC Nana-EC left a comment

Choose a reason for hiding this comment

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

Looks good, suggestion on text since the open source code should reference 1 single deployed instance name like hashscan

openapi.yaml Outdated Show resolved Hide resolved
Co-authored-by: Nana Essilfie-Conduah <[email protected]>
Signed-off-by: Luis Mastrangelo <[email protected]>
@acuarica acuarica merged commit c6ee511 into main Jan 18, 2024
8 checks passed
@acuarica acuarica deleted the 117-fix-and-cleanup-sourcify-api-swagger-docs branch January 18, 2024 20:26
@acuarica acuarica added the enhancement Enhancing an existing feature driven by business requirements. Typically backwards compatible. label May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancing an existing feature driven by business requirements. Typically backwards compatible.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix and cleanup Sourcify API Swagger Docs
3 participants