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.

Sign up for GitHub

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

Jump to bottom

[Story] Add link to API docs to OC web app #2208

Closed
1 task done
tschaffter opened this issue Oct 6, 2023 · 2 comments · Fixed by #2216
Closed
1 task done

[Story] Add link to API docs to OC web app #2208

tschaffter opened this issue Oct 6, 2023 · 2 comments · Fixed by #2216
Assignees
@vpchung
Labels
api/spec API specification frontend Frontend development

Comments

@tschaffter
Copy link
Member

What product(s) is this feature for?

OpenChallenges

Description

The OC API docs is available on https://openchallenges.io/api-docs.

The goal of this ticket is to inform the user that an API docs is available and where to find it.

Anything else?

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@tschaffter tschaffter added the frontend Frontend development label Oct 6, 2023
@tschaffter tschaffter changed the title [Feature] Add link to API docs to OC web app [Story] Add link to API docs to OC web app Oct 6, 2023
@tschaffter tschaffter added the api/spec API specification label Oct 6, 2023
@vpchung vpchung mentioned this issue Oct 6, 2023
Merged
@vpchung
Copy link
Member

vpchung commented Oct 6, 2023

Do we want a page dedicated to this introduction as well (similar to Grand Challenge)?

Currently, I have simply added a link in the footer (see #2216) but can add another page if that makes more sense.

@tschaffter
Copy link
Member Author

This is a great idea! For now we only have the API docs to share so I think it's OK to simply redirect to the Redocli-generated page. We could then add an individual page when once we have versioned API clients for Python and R.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vpchung vpchung

Labels
api/spec API specification frontend Frontend development
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(openchallenges): add link to OC API docs vpchung/sage-monorepo
2 participants
@tschaffter @vpchung