Docs for ISO generation are missing optional properties

apache / trafficcontrol

Apache Traffic Control is an Open Source implementation of a Content Delivery Network

https://trafficcontrol.apache.org/

Apache License 2.0

1.06k stars 341 forks source link

Docs for ISO generation are missing optional properties #7360

Open ocket8888 opened 1 year ago

ocket8888 commented 1 year ago

This Bug Report affects these Traffic Control components:

Documentation

Current behavior:

The docs for the /isos TO API endpoint in all versions are missing descriptions for the following optional request properties:

mgmtIpAddress - management interface IP address
mgmtIpNetmask - management interface IP netmask
mgmtIpGateway - management interface gateway IP address
mgmtInterface - management interface network interface device name

Expected behavior:

Documentation should be complete and accurate.

Steps to reproduce:

Read the docs

Exar04 commented 1 year ago

hey can i work on this. I am new to OS. Where do i start? Reading the docs and then?

ocket8888 commented 1 year ago

Our documentation lives under doc/source/ and can be built using make from within doc/ (see the documentation section on building the documentation). The API documentation is in docs/source/api/ which has subdirectories for each API version (v3, v4, and v5) which each contain a file describing the /isos endpoint that is missing the above property descriptions.

AdityaMayukhSom commented 8 months ago

As no one else is currently working on this, I have started working on the issue. Will open a PR soon.