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

Swagger UI #805

Open
wants to merge 54 commits into
base: main
Choose a base branch
from
Open

Swagger UI #805

wants to merge 54 commits into from

Conversation

dlrice
Copy link
Contributor

@dlrice dlrice commented Jul 25, 2024

Purpose

Swagger-UI first implementation

Approach

  • Continue from @aurel-l's branch.
  • Fetch open api definition from rest
  • Style/reuse components for rest of website

Testing

Yes

Checklist

  • My PR is scoped properly, and “does one thing only”
  • I have reviewed my own code
  • I have checked that linting checks pass and type safety is respected
  • I have checked that tests pass and coverage has at least improved, and if not explained the reasons why

src/help/components/entry/ApiDocumentation.tsx Outdated Show resolved Hide resolved
src/help/config/apiUrls.ts Outdated Show resolved Hide resolved
src/help/utils/__tests__/apiDocumentation.spec.tsx Outdated Show resolved Hide resolved
src/help/utils/apiSnippets.tsx Outdated Show resolved Hide resolved
src/help/utils/apiSnippets.tsx Outdated Show resolved Hide resolved
src/help/utils/apiSnippets.tsx Show resolved Hide resolved
src/help/utils/apiSnippets.tsx Outdated Show resolved Hide resolved
src/help/utils/apiSnippets.tsx Show resolved Hide resolved
src/help/utils/apiSnippets.tsx Outdated Show resolved Hide resolved
return '# No automatic snippet, work in progress';
}

return `# Perl not recommended, limited support
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Are we trying to say that Perl in general is not recommended to access our API or just that the specific snippets may not work? I'm thinking in general we should be fully supporting perl (and R) or any other means of accessing our API as it's just making HTTP. What do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

It's not really that we won't be giving support but rather to push people to use Python and to not expect support for Perl or R, first because in the team we don't really use this, and then to deter new bioinformaticians because in 2024 it might not be the best thing to learn first (especially Perl) unless they have a really good reason.
We could rephrase as "Limited support by the UniProt helpdesk in Perl" or something else that would not make it sound like we say the language itself is deprecated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good, maybe something like: "Note that there is limited UniProt help desk support for Perl-related questions."

src/help/utils/apiSnippets.tsx Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants