senaite.jsonapi


Namesenaite.jsonapi JSON
Version 2.5.0 PyPI version JSON
download
home_pagehttps://github.com/senaite/senaite.jsonapi
SummarySENAITE JSON API
upload_time2024-01-03 16:06:46
maintainer
docs_urlNone
authorRIDING BYTES & NARALABS
requires_python
licenseGPLv2
keywords
VCS
bugtrack_url
requirements setuptools zc.buildout wheel
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://raw.githubusercontent.com/senaite/senaite.jsonapi/master/static/logo_pypi.png
   :target: https://github.com/senaite/senaite.jsonapi
   :alt: senaite.jsonapi
   :height: 128px

RESTful JSON API for SENAITE LIMS
=================================

.. image:: https://img.shields.io/pypi/v/senaite.jsonapi.svg?style=flat-square
    :target: https://pypi.python.org/pypi/senaite.jsonapi

.. image:: https://img.shields.io/travis/senaite/senaite.jsonapi/master.svg?style=flat-square
    :target: https://travis-ci.org/senaite/senaite.jsonapi

.. image:: https://readthedocs.org/projects/pip/badge/
  :target: https://senaitejsonapi.readthedocs.org

.. image:: https://img.shields.io/github/issues-pr/senaite/senaite.jsonapi.svg?style=flat-square
    :target: https://github.com/senaite/senaite.jsonapi/pulls

.. image:: https://img.shields.io/github/issues/senaite/senaite.jsonapi.svg?style=flat-square
    :target: https://github.com/senaite/senaite.jsonapi/issues

.. image:: https://img.shields.io/badge/Made%20for%20SENAITE-%E2%AC%A1-lightgrey.svg
   :target: https://www.senaite.com


About
-----

This SENAITE.JSONAPI is a RESTful JSON API for `SENAITE LIMS`_, that allows to
Create, Read and Update (CRU operations) through http GET/POST requests. It uses
JSON as the format for data representation.


Installation
------------

Add *senaite.jsonapi* in the eggs section of your buildout:

.. code-block:: ini

  eggs =
      senaite.lims
      senaite.jsonapi


and run *bin/buildout*.


Documentation
-------------

* https://senaitejsonapi.readthedocs.io


Feedback and support
--------------------

* `Community site <https://community.senaite.org/>`_
* `Gitter channel <https://gitter.im/senaite/Lobby>`_
* `Users list <https://sourceforge.net/projects/senaite/lists/senaite-users>`_


License
-------

**SENAITE.JSONAPI** Copyright (C) RIDING BYTES & NARALABS

This program is free software; you can redistribute it and/or modify it under
the terms of the `GNU General Public License version 2
<https://github.com/senaite/senaite.jsonapi/blob/master/LICENSE>`_ as published
by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.


.. Links

.. _SENAITE LIMS: https://www.senaite.com


Changelog
=========

2.5.0 (2024-01-03)
------------------

- #59 Fix search route for (multi-) portal type queries
- #58 Fix missing portal type in query
- #57 Fix search catalog for metadata lookup
- #56 Fix implicit imports for controlpanel mappings
- #54 Lookup mapped catalogs for CatalogBrains


2.4.0 (2023-03-10)
------------------

- #51 Handle no access to parent object gracefully


2.3.0 (2022-10-03)
------------------

- #49 Fix no error message is sent back for push consumer calls


2.2.0 (2022-06-10)
------------------

- #47 Use searchable text index converter from catalog API
- #46 Fix ZCTextIndex lookup for custom searchable text query


2.1.0 (2022-01-05)
------------------

- #43 Fix malformed API call


2.0.0 (2021-07-27)
------------------

- Version bump


2.0.0rc2 (2020-10-13)
---------------------

- #41 Added push endpoint for custom jobs


2.0.0rc1 (2020-08-05)
---------------------

- Compatibility with `senaite.core` 2.x


1.2.4 (unreleased)
------------------

- #41 Push endpoint for custom jobs


1.2.3 (2020-08-05)
------------------

- #40 Prevent the id of objects of being accidentally updated
- #40 Do not allow to update objects from setup folder
- #40 Do not allow to update objects from portal root
- #40 Fix upgrade does not work on post-only mode
- #40 Adapter for custom handling of `update` operation
- #37 Do not allow to create objects in setup folder
- #37 Do not allow to create objects in portal root
- #37 Adapter for custom handling of `create` operation
- #37 Make the creation operation to be portal_type-naive
- #35 Added `catalogs` route
- #34 Make senaite.jsonapi catalog-agnostic on searches


1.2.2 (2020-03-03)
------------------

- Missing package data


1.2.1 (2020-03-02)
------------------

- Fixed tests and updated build system


1.2.0 (2018-01-03)
------------------

**Added**

- Added `parent_path` to response data
- Allow custom methods as attributes in adapter

**Removed**

**Changed**

- Integration to SENAITE CORE
- License changed to GPLv2

**Fixed**

- #25 Null values are saved as 'NOW' in Date Time Fields
- Fixed Tests

**Security**


1.1.0 (2017-11-04)
------------------

- Merged PR https://github.com/collective/plone.jsonapi.routes/pull/90
- Get object by UID catalog


1.0.1 (2017-09-30)
------------------

- Fixed broken release (missing MANIFEST.in)


1.0.0 (2017-09-30)
------------------

- First release
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/senaite/senaite.jsonapi",
    "name": "senaite.jsonapi",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "RIDING BYTES & NARALABS",
    "author_email": "senaite@senaite.com",
    "download_url": "https://files.pythonhosted.org/packages/18/6f/538905722b0afd6f5c1b13424cf782a3f4b36be3fa99d03937b1e5bd8ecf/senaite.jsonapi-2.5.0.zip",
    "platform": null,
    "description": ".. image:: https://raw.githubusercontent.com/senaite/senaite.jsonapi/master/static/logo_pypi.png\n   :target: https://github.com/senaite/senaite.jsonapi\n   :alt: senaite.jsonapi\n   :height: 128px\n\nRESTful JSON API for SENAITE LIMS\n=================================\n\n.. image:: https://img.shields.io/pypi/v/senaite.jsonapi.svg?style=flat-square\n    :target: https://pypi.python.org/pypi/senaite.jsonapi\n\n.. image:: https://img.shields.io/travis/senaite/senaite.jsonapi/master.svg?style=flat-square\n    :target: https://travis-ci.org/senaite/senaite.jsonapi\n\n.. image:: https://readthedocs.org/projects/pip/badge/\n  :target: https://senaitejsonapi.readthedocs.org\n\n.. image:: https://img.shields.io/github/issues-pr/senaite/senaite.jsonapi.svg?style=flat-square\n    :target: https://github.com/senaite/senaite.jsonapi/pulls\n\n.. image:: https://img.shields.io/github/issues/senaite/senaite.jsonapi.svg?style=flat-square\n    :target: https://github.com/senaite/senaite.jsonapi/issues\n\n.. image:: https://img.shields.io/badge/Made%20for%20SENAITE-%E2%AC%A1-lightgrey.svg\n   :target: https://www.senaite.com\n\n\nAbout\n-----\n\nThis SENAITE.JSONAPI is a RESTful JSON API for `SENAITE LIMS`_, that allows to\nCreate, Read and Update (CRU operations) through http GET/POST requests. It uses\nJSON as the format for data representation.\n\n\nInstallation\n------------\n\nAdd *senaite.jsonapi* in the eggs section of your buildout:\n\n.. code-block:: ini\n\n  eggs =\n      senaite.lims\n      senaite.jsonapi\n\n\nand run *bin/buildout*.\n\n\nDocumentation\n-------------\n\n* https://senaitejsonapi.readthedocs.io\n\n\nFeedback and support\n--------------------\n\n* `Community site <https://community.senaite.org/>`_\n* `Gitter channel <https://gitter.im/senaite/Lobby>`_\n* `Users list <https://sourceforge.net/projects/senaite/lists/senaite-users>`_\n\n\nLicense\n-------\n\n**SENAITE.JSONAPI** Copyright (C) RIDING BYTES & NARALABS\n\nThis program is free software; you can redistribute it and/or modify it under\nthe terms of the `GNU General Public License version 2\n<https://github.com/senaite/senaite.jsonapi/blob/master/LICENSE>`_ as published\nby the Free Software Foundation.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\n\n.. Links\n\n.. _SENAITE LIMS: https://www.senaite.com\n\n\nChangelog\n=========\n\n2.5.0 (2024-01-03)\n------------------\n\n- #59 Fix search route for (multi-) portal type queries\n- #58 Fix missing portal type in query\n- #57 Fix search catalog for metadata lookup\n- #56 Fix implicit imports for controlpanel mappings\n- #54 Lookup mapped catalogs for CatalogBrains\n\n\n2.4.0 (2023-03-10)\n------------------\n\n- #51 Handle no access to parent object gracefully\n\n\n2.3.0 (2022-10-03)\n------------------\n\n- #49 Fix no error message is sent back for push consumer calls\n\n\n2.2.0 (2022-06-10)\n------------------\n\n- #47 Use searchable text index converter from catalog API\n- #46 Fix ZCTextIndex lookup for custom searchable text query\n\n\n2.1.0 (2022-01-05)\n------------------\n\n- #43 Fix malformed API call\n\n\n2.0.0 (2021-07-27)\n------------------\n\n- Version bump\n\n\n2.0.0rc2 (2020-10-13)\n---------------------\n\n- #41 Added push endpoint for custom jobs\n\n\n2.0.0rc1 (2020-08-05)\n---------------------\n\n- Compatibility with `senaite.core` 2.x\n\n\n1.2.4 (unreleased)\n------------------\n\n- #41 Push endpoint for custom jobs\n\n\n1.2.3 (2020-08-05)\n------------------\n\n- #40 Prevent the id of objects of being accidentally updated\n- #40 Do not allow to update objects from setup folder\n- #40 Do not allow to update objects from portal root\n- #40 Fix upgrade does not work on post-only mode\n- #40 Adapter for custom handling of `update` operation\n- #37 Do not allow to create objects in setup folder\n- #37 Do not allow to create objects in portal root\n- #37 Adapter for custom handling of `create` operation\n- #37 Make the creation operation to be portal_type-naive\n- #35 Added `catalogs` route\n- #34 Make senaite.jsonapi catalog-agnostic on searches\n\n\n1.2.2 (2020-03-03)\n------------------\n\n- Missing package data\n\n\n1.2.1 (2020-03-02)\n------------------\n\n- Fixed tests and updated build system\n\n\n1.2.0 (2018-01-03)\n------------------\n\n**Added**\n\n- Added `parent_path` to response data\n- Allow custom methods as attributes in adapter\n\n**Removed**\n\n**Changed**\n\n- Integration to SENAITE CORE\n- License changed to GPLv2\n\n**Fixed**\n\n- #25 Null values are saved as 'NOW' in Date Time Fields\n- Fixed Tests\n\n**Security**\n\n\n1.1.0 (2017-11-04)\n------------------\n\n- Merged PR https://github.com/collective/plone.jsonapi.routes/pull/90\n- Get object by UID catalog\n\n\n1.0.1 (2017-09-30)\n------------------\n\n- Fixed broken release (missing MANIFEST.in)\n\n\n1.0.0 (2017-09-30)\n------------------\n\n- First release",
    "bugtrack_url": null,
    "license": "GPLv2",
    "summary": "SENAITE JSON API",
    "version": "2.5.0",
    "project_urls": {
        "Homepage": "https://github.com/senaite/senaite.jsonapi"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "186f538905722b0afd6f5c1b13424cf782a3f4b36be3fa99d03937b1e5bd8ecf",
                "md5": "f3a5420628e9302b019d75af0cc1353f",
                "sha256": "73f1f9dc3b312643dc2b54f65dbe1c43551614a4f0f1979110db83cc9649cc9d"
            },
            "downloads": -1,
            "filename": "senaite.jsonapi-2.5.0.zip",
            "has_sig": false,
            "md5_digest": "f3a5420628e9302b019d75af0cc1353f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 90098,
            "upload_time": "2024-01-03T16:06:46",
            "upload_time_iso_8601": "2024-01-03T16:06:46.328169Z",
            "url": "https://files.pythonhosted.org/packages/18/6f/538905722b0afd6f5c1b13424cf782a3f4b36be3fa99d03937b1e5bd8ecf/senaite.jsonapi-2.5.0.zip",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-03 16:06:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "senaite",
    "github_project": "senaite.jsonapi",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "setuptools",
            "specs": [
                [
                    "==",
                    "44.1.1"
                ]
            ]
        },
        {
            "name": "zc.buildout",
            "specs": [
                [
                    "==",
                    "2.13.3"
                ]
            ]
        },
        {
            "name": "wheel",
            "specs": []
        }
    ],
    "lcname": "senaite.jsonapi"
}
        
Elapsed time: 0.15878s