F5Networks / f5-appsvcs-templates

F5 BIG-IP Application Service Templates (FAST)
Apache License 2.0
32 stars 13 forks source link

Documentation: Clarify difference of FAST API PUT and POST method #125

Open simonkowallik opened 1 year ago

simonkowallik commented 1 year ago

Is your feature request related to a problem? Please describe.

The difference between using PUT or POST to create applications is unclear.

Describe the solution you'd like

Please clarify when to use PUT and when to use POST in the documentation.

Describe alternatives you've considered

Additional context

Context: Improve Documentation

shyawnkarim commented 1 year ago

Generally, use PUT when you want to UPDATE something and use POST when you want to CREATE something. Is there something specific that you are looking to see in the documentation?

simonkowallik commented 1 year ago

Besides the CRUD principles and their associated HTTP methods, is there any implementation difference, eg. performance gain, when initially using POST with FAST and then switching to PUT when making modifications at a later stage?

Based on the docs and my tests both methods are interchangeable. Hence a clarification in the documentation would be appreciated.

shyawnkarim commented 1 year ago

Thanks for that added clarity, this documentation request is now being tracked internally with ID, EC-183.