Documentation API - Save Bug

[weierophinney]

I encounter this bug (on DB-connected service) :

The API documentation does not record, only the general description is recorded, collection entity, GET, POST, etc ... they are not recorded.
I have to write to the hands the file documentation.config.php but reading documentation its works.

If i change documentation with the admin interface, i lost the documentation, persists only the general description. This suggests to error when saving but no error in the logs files.

After looking at the source code and make some testing, the problem would be the parameter "$controllerType" in method "storeDocumentation" because "controllerType" take the value "RPC" while I save documention a "REST" service. So the method "getSchemaTemplate" does not return the correct documentation template and the method "storeDocumentation" does not correctly recorded documentation see "storeDocumentation" (array_intersect_key)

I guess the problem just webapp (js/controllers/api-documentation.js)
Afer some testing I arrive on file (js/services/api.js) on method "saveDocumentation" and two paramters :

• Paramter 1 "url" : in my case : http://{domaine}/apigility/api/module/{API name}/rpc/{Controller Name}/doc

The problem is in url "RPC" while I work on "REST" service, if I replace "RPC" by "REST" its works, the documentation is correctly recorded but only for services "REST" because I just quickly test with : url = url.replace('rpc', 'rest');

• Parameter 2 "api.documentation" : documentation send is clean.

I work on debian 7 - Apache 2.2.22 - PHP (mod) 5.4.4 - browser: Chrome and Iceweasel

[edipoReboucas]

This bug happens when I change to documentation tab, not only on db-connected services.

Maybe this is a client bug.

My workaround for now is force the #controllerType value to 'rest'.

[weierophinney]

I have been unable to reproduce this -- switching between RPC and REST services, I've been able to update documentation without a problem.

js/services/api.js uses the self relational link in order to build the API service URI for updating the documentation. As such, the service type segment should not be changing; it should be static based on what the API returned for the service in the first place.

If I can reproduce this, I'll work on a fix; in the meantime, if you can reliably reproduce it, keep tracing, and find out what is being stored for the API's _self member; if that value is getting modified, figure out where, and report here.

[weierophinney]

Okay, reproduced here. Trying to work on a fix.

[weierophinney]

Discovered the root cause of the problem: the API is creating the documentation relational links incorrectly, and using /rpc/ instead of /rest/ within the generated URIs for REST services. I'll get this updated shortly.

[weierophinney]

Fixed. You can test it out by changing the "zf-apigility-admin" entry in your composer.json to use the version ~1.0-dev@dev, and then running composer update.

[edipoReboucas]

Fixed. I tested with rest and rpc services.
Tks.

[jebbdomingo]

Please update Apigility documentation "Creating a REST Service" https://www.apigility.org/documentation/intro/first-rest-service, the "Documentation" section didn't work due to this bug.

Kind Regards,

[weierophinney]

@jeboy There's no reason to update the documentation; this functionality worked prior to 1.0.4, and will work with the next release (or, if you're adventurous, with current master).

@edipoReboucas Thanks for the verification!

[cookejames]

Thanks for the fix, I had tracked down the problem but luckily found this bug before creating a fix. I can confirm that this is fixed for me now that I've updated to 1.0.6.

[EagleEyeJohn]

@weierophinney version ~1.0-dev@dev didn't work for me, but dev-master did fix this issue.