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

Update API Description with Contact Email and Remove License Box #46

Merged
merged 2 commits into from
Sep 24, 2024

Conversation

elmiomar
Copy link
Contributor

This PR includes the following changes:

1. Added a contact email to the API description:

  • The contact email [email protected] was added to the end of the description field in the info section of the OpenAPI spec.
  • The updated description is:
    "These are set of APIs which return the NIST public data repository related information. First one is the Search and discover API to get the dataset results for given criteria or dataset identifier. Second is to get different versions of the records or metadata for given dataset. Third one is to get the usage metrics for different datasets. For any inquiries, please contact the support team at [email protected]."

2. Removed the license box from the spec:

  • The license field, that includes the name, url, and identifier, was removed from the OpenAPI spec to prevent buggy rendering of the license box. Ticket regarding this bug can be found here.

These changes were tested locally.

image

Copy link
Collaborator

@RayPlante RayPlante left a comment

Choose a reason for hiding this comment

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

Updated version property to match rmm release. Tested on oardev; works.

@RayPlante RayPlante merged commit 053b46e into integration Sep 24, 2024
2 checks passed
@RayPlante RayPlante deleted the fix/remove-info-box branch September 24, 2024 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants