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 configuration options for Server Info section #13

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

MarcEspiard
Copy link

Description

Added the ability to configure additional entries of the Info section:

  • termsOfService
  • license
  • contact

Motivation and context

It wasn't possible to do so before this PR and was in the TODO list.
We need it for our current project

How has this been tested?

Generation has been tested with and without the changes enabled, all works as intended. This is a very simple change.

Screenshots (if appropriate)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

Go over all the following points, and put an x in all the boxes that apply.

Please, please, please, don't send your pull request until all of the boxes are ticked. Once your pull request is created, it will trigger a build on our continuous integration server to make sure your tests and code style pass.

  • I have read the CONTRIBUTING document.
  • My pull request addresses exactly one patch/feature.
  • I have created a branch for this patch/feature.
  • Each individual commit in the pull request is meaningful.
  • I have added tests to cover my changes.
  • If my change requires a change to the documentation, I have updated it accordingly.

If you're unsure about any of these, don't hesitate to ask. We're here to help!

@JaZo JaZo requested a review from Rocksheep June 8, 2023 06:13
Copy link
Collaborator

@Rocksheep Rocksheep left a comment

Choose a reason for hiding this comment

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

Thank you for creating this PR. The code works like a charm, but it needs some small adjustments in the formatting of the code!

src/Descriptors/Server.php Outdated Show resolved Hide resolved
src/Descriptors/Server.php Outdated Show resolved Hide resolved
@MarcEspiard
Copy link
Author

No problem, all done :)

@JaZo
Copy link
Member

JaZo commented Jun 9, 2023

The only concern I have is that, when we merge this, all existing users will have the example.com URLs in their documentation. I think we should leave the defaults empty for now. Maybe just comment them out or something like that?

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