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

Typo in documentation for /sytem/api #246

Closed
robindbe opened this issue Jun 10, 2022 · 1 comment · Fixed by #247
Closed

Typo in documentation for /sytem/api #246

robindbe opened this issue Jun 10, 2022 · 1 comment · Fixed by #247
Assignees
@jaredhendrickson13
Labels
documentation Improvements or additions to documentation

Comments

@robindbe
Copy link

robindbe commented Jun 10, 2022 •
edited
Loading

Describe the bug
This is a very minor typo but nonetheless.

The documentation for the PUT request in /api/v1/system/api says the parameter to set the listening interface is called available_interfaces but it's actually allowed_interfaces.

To Reproduce
Go to documentation page https://hostname/api/documentation/#/System%20%3E%20API/put_api_v1_system_api

pfSense Version & Package Version:

  • pfSense Version: 2.6.0
  • Package Version 1.4.2

Affected Endpoints:

  • URL: /api/v1/system/api
jaredhendrickson13 added a commit that referenced this issue Jun 11, 2022
@jaredhendrickson13
Corrected typo in /api/v1/system/api documentation that wrongfully st…
5fffa6e 
…ates the 'allowed_interfaces' field as 'available_interfaces' #246
@jaredhendrickson13 jaredhendrickson13 mentioned this issue Jun 11, 2022
Merged
@jaredhendrickson13 jaredhendrickson13 added the documentation Improvements or additions to documentation label Jun 11, 2022
@jaredhendrickson13 jaredhendrickson13 self-assigned this Jun 11, 2022
@jaredhendrickson13
Copy link
Owner

Thanks for pointing this out. I'll get this corrected right away.

@jaredhendrickson13 jaredhendrickson13 linked a pull request Jun 11, 2022 that will close this issue
Fix typo for 'allowed_interfaces' on /api/v1/system/api documentation #247
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jaredhendrickson13 jaredhendrickson13

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix typo for 'allowed_interfaces' on /api/v1/system/api documentation jaredhendrickson13/pfsense-api
2 participants
@jaredhendrickson13 @robindbe