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 Documentation for V2 API #820

Merged
merged 5 commits into from
Jan 14, 2025
Merged

Conversation

haideriqbal
Copy link
Collaborator

No description provided.

Copy link
Collaborator

@henrietteharmse henrietteharmse left a comment

Choose a reason for hiding this comment

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

Please document responses as well in terms of defined fields. We cannot document all fields in the response as this will be ontology dependent, but we can document defined fields.

@haideriqbal
Copy link
Collaborator Author

Have added a defined field list page to OLS. When user click it from the help page it will take them to a table listing all the defined fields. They are automatically populated from defined fields enum so we don't need to worry about updating this page in future when we add more defined fields.

Screenshot 2025-01-14 at 15 34 35

Screenshot 2025-01-14 at 15 34 51

Copy link
Collaborator

@henrietteharmse henrietteharmse left a comment

Choose a reason for hiding this comment

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

Nice!

@haideriqbal haideriqbal merged commit dd67b89 into dev Jan 14, 2025
1 check passed
@haideriqbal haideriqbal deleted the add-v2-api-documentation branch January 14, 2025 17:21
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.

2 participants