Deprecated functionality
Deprecated features are features that Orion stills support but that are not maintained or evolved any longer. In particular:
- Bugs or issues related with deprecated features and not affecting any other feature are not addressed (they are closed in github.com as soon as they are spotted).
- Documentation on deprecated features is removed from the repository documentation. Documentation is still available in the documentation set associated to older versions (either in the repository release branches or the pre-0.23.0 documentation in the FIWARE wiki).
- Deprecated functionality is eventually removed from Orion. Thus you are strongly encouraged to change your implementations using Orion in order not rely on deprecated functionality.
A list of deprecated features and the version in which they were deprecated follows:
geo:point
,geo:line
,geo:box
andgeo:polygon
attribute types in Orion 3.10.0. Usegeo:json
instead.GET /v2
operation in Orion 3.8.0. This operation is pretty useless and not actually used.- Initial notification in subscriptions (along with
skipInitialNotification
option) in Orion 3.1.0. (removed in Orion 3.2.0). The results covered by initial notification can be very large and we cannot apply pagination here (as it is done in the synchronous retrieval of entities usingGET /v2/entities
). In fact, only the first 20 entities are returned, which makes this funcionality very limited. As alternative, if you need to know the status of your system at subscription time, then useGET /v2/entities
with proper pagination. - Rush support (along with the related CLI parameter:
-rush
) in Orion 2.1.0 (removed in Orion 2.3.0). - NGSIv1 API (along with related CLI parameters:
-strictNgsiv1Ids
and-ngsiv1Autocast
) in Orion 2.0.0. Use NGSIv2 API instead.- Context availability subscriptions (AKA NGSI9 subscriptions), as part of NGSIv1, in Orion 2.0.0 (removed in Orion 2.6.0)
- All the other NGSIv1 operations removed in Orion 3.10.0, except the following ones:
PUT /v1/contextEntities/{id}
DELETE /v1/contextEntities/{id}
GET /v1/contextEntities/{id}/attributes/{name}
POST /v1/updateContext
POST /NGSI10/updateContext
POST /v1/queryContext
POST /NGSI10/queryContext
attributes
field inPOST /v2/op/query
is in Orion 1.15.0. It is a combination ofattrs
(to select which attributes to include in the response to the query) and unary attribute filter inq
withinexpression
(to return only entities which have these attributes). Use them instead.- Usage of that is
APPEND
,APPEND_STRICT
,UPDATE
,DELETE
andREPLACE
inPOST /v2/op/update
is deprecated in Orion 1.14.0. Useappend
,appendStrict
,update
,delete
andreplace
counterparts. - Metadata ID is deprecated in Orion 1.13.0 (removed in Orion 2.2.0). On the one hand, this functionality is not compatible with the
NGSIv2 JSON representation format (attribute names are used as keys in a JSON object, so names cannot be
duplicated). On the other hand, IDs can easily be implemented using prefixes/suffixes in attribute names,
e.g.
temperature:ground
andtemperature:ceiling
. As a consecuence of this deprecation, the following operations are also deprecated:GET /v1/contextEntities/{entityId}/attributes/{attrName}/{attrId}
GET /v1/contextEntities/type/{entityType}/id/{entityId}/attributes/{attrName}/{attrId}
POST /v1/contextEntities/type/{entityType}/id/{entityId}/attributes/{attrName}/{attrId}
PUT /v1/contextEntities/{entityId}/attributes/{attrName}/{attrId}
PUT /v1/contextEntities/type/{entityType}/id/{entityId}/attributes/{attrName}/{attrId}
DELETE /v1/contextEntities/{entityId}/attributes/{attrName}/{attrId}
DELETE /v1/contextEntities/type/{entityType}/id/{entityId}/attributes/{attrName}/{attrId}
- The usage of
options
URL parameter in order to includedateCreated
and/ordateModified
attributes in NGSIv2 is deprecated in Orion 1.5.0. Please useattrs
URI parameter instead. /ngsi10
and/ngsi9
as URL path prefixes are deprecated in Orion 1.2.0. Please, use/v1
and/v1/registry
instead. */ngsi9
URL paths removed in Orion 3.8.0location
metadata to specify entity location is deprecated in Orion 1.1.0 (removed in Orion 3.11.0). The new way of specifying entity location is to usegeo:json
type for the attribute (see details in the corresponding section of the Orion API specification.- Deprecated command line argument in Orion 0.26.1 (removed in Orion 1.0.0).
- --silent. Suppress all log output except errors (Please use -logLevel ERROR instead)
- ONTIMEINTERVAL subscriptions are deprecated since Orion 0.26.0 (removed in Orion 1.0.0). ONTIMEINTERVAL subscriptions have several problems (introduce state in CB, thus making horizontal scaling configuration much harder, and makes it difficult to introduce pagination/filtering). Actually, they aren't really needed, as any use case based on ONTIMEINTERVAL notification can be converted to an equivalent use case in which the receptor runs queryContext at the same frequency (and taking advantage of the features of queryContext, such as pagination or filtering).
- XML is deprecated since Orion 0.23.0 (removed in Orion 1.0.0).
- Deprecated command line arguments in Orion 0.21.0 (removed in 0.25.0):
- -ngsi9. The broker runs only NGSI9 (NGSI10 is not used).
- -fwdHost
. Forwarding host for NGIS9 registerContext when the broker runs in "ConfMan mode". - -fwdPort
. Forwarding port for NGIS9 registerContext when the broker runs in "ConfMan mode".
- Configuration Manager role (deprecated in 0.21.0, removed in 0.25.0)
- Associations (deprecated in 0.21.0, removed in 0.25.0).
Log deprecation warnings
Some (not all) usages of deprecated features can be logged using the -logDeprecate
CLI flag
(or deprecate
parameter in the log admin REST API)
in the WARN log level).
Have a look to this section of the documentation for more detail about this.
Using old Orion versions
Although you are encouraged to use always the newest Orion version, take into account the following information in the case you want to use old versions:
- Code corresponding to old releases (since Orion 0.8.1, the first one available as open source) is
available at the Orion github repository. Each release number
(e.g. 0.23.0) has associated the following:
- A tag, e.g.
0.23.0
. It points to the base version. - A release branch,
release/0.23.0
. The HEAD of this branch usually matches the aforementioned tag. However, if some hotfixes were developed on the base version, this branch contains such hotfixes.
- A tag, e.g.
- Documentation corresponding to old versions can be found:
- For 0.23.0 and before: documentation is available at FIWARE public wiki (user manual and admin manual).
- For 0.24.0 or newer: documentation is available at readthedocs.io. Use the panel in the left bottom corner to navigate to the right version.
- Docker images corresponding to Orion 0.24.0 and newer can be found at Dockerhub.
The following table provides information about the last Orion version supporting currently removed features:
Removed feature | Last Orion version supporting feature | That version release date |
---|---|---|
attributes field in POST /v2/entities operation |
Not yet defined | Not yet defined |
APPEND , UPDATE , etc. action types in POST /v2/op/update |
Not yet defined | Not yet defined |
dateCreated and dateModified in options URI parameter |
Not yet defined | Not yet defined |
GET /v2 operation |
Not yet defined | Not yet defined |
geo:point , geo:line , geo:box and geo:polygon attribute types |
Not yet defined | Not yet defined |
location metadata to specify entity location |
3.10.1 | June 12th, 2023 |
NGSIv1 API (along with CLI: -strictNgsiv1Ids and -ngsiv1Autocast ) |
3.9.0 (*) | June 2nd, 2023 |
/ngsi10 and /ngsi9 URL prefixes |
3.7.0 (*) | May 26th, 2022 |
Initial notification upon subscription creation or update | 3.1.0 | June 9th, 2021 |
NGSIv1 Context availability subscriptions (NGSI9 suscriptions) | 2.5.2 | December 17th, 2020 |
Rush (along with CLI: -rush ) |
2.2.0 | February 21st, 2019 |
id metadata (and associated NGSIv1 operations) |
2.1.0 | December 19th, 2018 |
XML API | 0.28.0 | February 29th, 2016 |
ONTIMEINTERVAL subscription | 0.28.0 | February 29th, 2016 |
CLI --silent |
0.28.0 | February 29th, 2016 |
Configuration Manager role (including -ngsi9 , -fwdHost and -fwdPort ) |
0.24.0 | September 14th, 2015 |
Associations | 0.24.0 | September 14th, 2015 |
(*) The removal was not fully done in a single version, but this is last one in which the functionality was still complete