[Mayan EDMS: 2356] Documentation mismatch with reality

[RW Shore]

The documentation for the API function that creates a new tag (POST
/api/tags/tags) indicates an optional parameter documents_pk_list. This
parameter does not actually exist; a POST request to this function that
includes field documents_pk_list fails with a 400 (Bad Request) response.

[Michael Price]

Thanks! I've been cleaning up the API a lot. The documentation capabilities
of Django REST framework leave a lot to be desired. We just upgraded to the
latest DRF. Checkout the screenshots for what's coming.

Post by RW Shore
The documentation for the API function that creates a new tag (POST
/api/tags/tags) indicates an optional parameter documents_pk_list. This
parameter does not actually exist; a POST request to this function that
includes field documents_pk_list fails with a 400 (Bad Request) response.

[RW Shore]

Dang, you just broke all my code :-) Oh well, the price of progress...

I can see that the REST URLs have changed. As far as you know, are the data
structures returned from the calls the same as under the old API? Just
trying to figure out what I'm going to have to do.

Post by Michael Price
Thanks! I've been cleaning up the API a lot. The documentation
capabilities of Django REST framework leave a lot to be desired. We just
upgraded to the latest DRF. Checkout the screenshots for what's coming.

Post by RW Shore
The documentation for the API function that creates a new tag (POST
/api/tags/tags) indicates an optional parameter documents_pk_list. This
parameter does not actually exist; a POST request to this function that
includes field documents_pk_list fails with a 400 (Bad Request) response.

--
---
You received this message because you are subscribed to the Google Groups
"Mayan EDMS" group.
To unsubscribe from this group and stop receiving emails from it, send an
For more options, visit https://groups.google.com/d/optout.

[Michael Price]

Sorry about that mate! :) The API change is the primary reason we numbered
this version 3.0 instead of 2.9. On the surface only the API URLs changed,
all the return codes and structures remained the same. The updates to your
code should be minimal. During the 3.x versions we don't expect to change
the API too much. unless really necessary. If there are drastic changes we
would move to a new major version. 4.0 In this case.

Post by RW Shore
Dang, you just broke all my code :-) Oh well, the price of progress...
I can see that the REST URLs have changed. As far as you know, are the
data structures returned from the calls the same as under the old API? Just
trying to figure out what I'm going to have to do.

Post by Michael Price
Thanks! I've been cleaning up the API a lot. The documentation
capabilities of Django REST framework leave a lot to be desired. We just
upgraded to the latest DRF. Checkout the screenshots for what's coming.

Post by RW Shore
The documentation for the API function that creates a new tag (POST
/api/tags/tags) indicates an optional parameter documents_pk_list. This
parameter does not actually exist; a POST request to this function that
includes field documents_pk_list fails with a 400 (Bad Request) response.

--
---
You received this message because you are subscribed to the Google Groups
"Mayan EDMS" group.
To unsubscribe from this group and stop receiving emails from it, send an
For more options, visit https://groups.google.com/d/optout.