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 possibility to configure termsOfService in info object of OpenAPI document #130

Closed
teezip opened this issue Dec 12, 2024 · 2 comments · Fixed by #131
Closed

Add possibility to configure termsOfService in info object of OpenAPI document #130

teezip opened this issue Dec 12, 2024 · 2 comments · Fixed by #131
Labels
enhancement New feature or request
Milestone

Comments

@teezip
Copy link
Collaborator

teezip commented Dec 12, 2024

For open APIs it would be needed to publish both open data license and terms of use like this in the info object of OpenAPI document:

"info": {
  "license" : {
      "name" : "Open data CC 4.0 licence.",
      "url" : "some url to opendata licence"
   },
   "termsOfService": "some url to terms of use for the open API service"
}

Currently termsOfService cannot be configured on Hakunapi. This support should be added at least in the conf parser and other places where Open API document is generated:

https://github.com/nlsfi/hakunapi/blob/main/src/hakunapi-core/src/main/java/fi/nls/hakunapi/core/config/HakunaConfigParser.java

@teezip teezip added the enhancement New feature or request label Dec 12, 2024
@teezip teezip added this to the 1.5.1 milestone Dec 12, 2024
@jampukka
Copy link
Collaborator

I'll add this, however it will only appear in the /api response. No real place for it in / landing page response schema.

@teezip
Copy link
Collaborator Author

teezip commented Dec 12, 2024

Thanks, adding this to the /api response should be enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants