Skip to content
GitLab
Explore
Sign in
CIM - Context Information Management
NGSI-LD API
Compare revisions
5a9b241b652d9127da75c043efeb4fe92a11a7ee to 8ef715db6cc76b40d72615b083283a2e83ce3e7d
Expand all
Show whitespace changes
Inline
Side-by-side
schema/temporal/EntityTemporal.json
View file @
8ef715db
{
"$schema"
:
"http://json-schema.org/schema#"
,
"$id"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json"
,
"title"
:
"NGSI-LD Entity"
,
"description"
:
"NGSI-LD Temporal Representation of an Entity"
,
"definitions"
:
{
...
...
@@ -46,7 +44,7 @@
}
},
"additionalProperties"
:
{
"
any
Of"
:
[
"
one
Of"
:
[
{
"type"
:
"array"
,
"items"
:
{
...
...
@@ -69,22 +67,19 @@
"minItems"
:
1
}
]
},
"propertyNames"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/PropertyNames"
}
},
"EntityTemporal"
:
{
"allOf"
:
[
{
"$ref"
:
"#/definitions/EntityTemporalFragment"
},
{
"type"
:
"object"
,
"required"
:
[
"
id
"
,
"
type
"
"
type
"
,
"
id
"
]
},
{
"$ref"
:
"#/definitions/EntityTemporalFragment"
}
]
}
...
...
schema/temporal/EntityTemporalList.json
View file @
8ef715db
{
"$schema"
:
"http://json-schema.org/schema#"
,
"$id"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporalList.json"
,
"title"
:
"NGSI-LD Entity"
,
"description"
:
"NGSI-LD Temporal Representation List"
,
"definitions"
:
{
"EntityTemporalList"
:
{
"type"
:
"array"
,
"items"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#
/definitions/EntityTemporal
"
}
}
},
...
...
schema/temporal/Entity_temporalValues.json
View file @
8ef715db
{
"$schema"
:
"http://json-schema.org/schema#"
,
"$id"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/Entity_temporalValues.json"
,
"title"
:
"NGSI-LD Entity Temporal Values"
,
"description"
:
"NGSI-LD Simplified Temporal Representation of Entities"
,
"definitions"
:
{
...
...
@@ -105,7 +103,7 @@
"id"
],
"additionalProperties"
:
{
"
any
Of"
:
[
"
one
Of"
:
[
{
"$ref"
:
"#/definitions/PropertyTemporalValues"
},
...
...
@@ -113,8 +111,5 @@
"$ref"
:
"#/definitions/RelationshipTemporalValues"
}
]
},
"propertyNames"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/PropertyNames"
}
}
\ No newline at end of file
scripts/combine_files.sh
deleted
100755 → 0
View file @
5a9b241b
#!/bin/bash
#
# Requires install swagger-cli: npm install -g swagger-cli
#
# Generate a file which combines all the spec files into a unique swagger definition file (maintains references)
swagger-cli bundle ./spec/updated/ngsi-ld-spec-open-api.json
-o
./bundle/ngsild_swagger_combined.json
# Generate a file which combines all the spec files into a unique swagger definition file (removes references)
# working with modified swagger-cli.js to avoid circular ref problem
swagger-cli
-d
bundle
--dereference
./spec/updated/ngsi-ld-spec-open-api.json
-o
./bundle/ngsild_swagger_combined_dereferenced.json
# modified version to allow circular ref
# swagger-cli bundle --dereference="ignore" ./spec/updated/ngsi-ld-spec-open-api.json -o ./bundle/ngsild_swagger_combined.json
\ No newline at end of file
scripts/runLocalDevEnv.sh
0 → 100755
View file @
8ef715db
#!/bin/bash
scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:8090
docker run
--name
spec-server
--rm
-d
-v
${
PWD
}
/:/ngsi
-e
FOLDER
=
/ngsi
-p
8090:8080 halverneus/static-file-server
read
-p
"Press enter to finish editing"
docker stop spec-server
scripts/setBasePath.sh http://localhost:8090 https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master
scripts/setBasePath.sh
0 → 100755
View file @
8ef715db
#!/bin/bash
toBeReplaced
=
$1
replacement
=
$2
for
i
in
$(
find spec
-type
f
-print
)
do
sed
-i
s,
${
toBeReplaced
}
,
${
replacement
}
,g
"
${
i
}
"
done
for
i
in
$(
find schema
-type
f
-print
)
do
sed
-i
s,
${
toBeReplaced
}
,
${
replacement
}
,g
"
${
i
}
"
done
\ No newline at end of file
spec/updated/csource-registration-by-id-spec.json
→
spec/updated/
csourceRegistrations/
csource-registration-by-id-spec.json
View file @
8ef715db
...
...
@@ -23,7 +23,7 @@
"get"
:
{
"description"
:
"Retrieves a specific context source registration from an NGSI-LD system"
,
"operationId"
:
"retrieveCsource"
,
"tags"
:
[
"Context Sources"
],
"tags"
:
[
"Context Sources"
,
"CSourceRegistrations"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/registrationId"
...
...
@@ -70,7 +70,7 @@
"delete"
:
{
"description"
:
"Removes an specific context source registration within an NGSI-LD system"
,
"operationId"
:
"removeCsource"
,
"tags"
:
[
"Context Sources"
],
"tags"
:
[
"Context Sources"
,
"CSourceRegistrations"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/registrationId"
...
...
spec/updated/csource-registrations-spec.json
→
spec/updated/
csourceRegistrations/
csource-registrations-spec.json
View file @
8ef715db
...
...
@@ -13,37 +13,37 @@
"get"
:
{
"description"
:
"Retrieve a set of context sources which matches a specific query from an NGSI-LD system"
,
"operationId"
:
"queryCsources"
,
"tags"
:
[
"Context Sources"
],
"tags"
:
[
"Context Sources"
,
"CSourceRegistrations"
],
"parameters"
:
[
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/id"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/id"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/idPattern"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/idPattern"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/type"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/type"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/attrs"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/attrs"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/q"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/q"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/georel"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/georel"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/geometry"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/geometry"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/coordinates"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/coordinates"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/geoproperty"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/geoproperty"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/limit"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/limit"
}
],
"responses"
:
{
...
...
@@ -77,7 +77,7 @@
"post"
:
{
"description"
:
"Registers a new context source within an NGSI-LD system"
,
"operationId"
:
"registerCsource"
,
"tags"
:
[
"Context Sources"
],
"tags"
:
[
"Context Sources"
,
"CSourceRegistrations"
],
"requestBody"
:
{
"required"
:
true
,
"content"
:
{
...
...
spec/updated/csource-subscription-by-id-spec.json
→
spec/updated/
csourceSubscriptions/
csource-subscription-by-id-spec.json
View file @
8ef715db
...
...
@@ -22,8 +22,8 @@
"/csourceSubscriptions/{subscriptionId}"
:
{
"get"
:
{
"description"
:
"Retrieves a specific Subscription from an NGSI-LD system"
,
"operationId"
:
"retrieveSubscription"
,
"tags"
:
[
"Context Sources"
],
"operationId"
:
"retrieve
CSource
Subscription
sById
"
,
"tags"
:
[
"Context Sources"
,
"CSourceSubscriptions"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/subscriptionId"
...
...
@@ -70,7 +70,7 @@
"patch"
:
{
"description"
:
"Updates a specific context source discovery Subscription within an NGSI-LD system"
,
"operationId"
:
"updateCSourceSubscription"
,
"tags"
:
[
"Context Sources"
],
"tags"
:
[
"Context Sources"
,
"CSourceSubscriptions"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/subscriptionId"
...
...
@@ -115,7 +115,7 @@
"delete"
:
{
"description"
:
"Removes a specific Context Source Subscription from an NGSI-LD system"
,
"operationId"
:
"removeCSourceSubscription"
,
"tags"
:
[
"Context Sources"
],
"tags"
:
[
"Context Sources"
,
"CSourceSubscriptions"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/subscriptionId"
...
...
spec/updated/csource-subscriptions-spec.json
→
spec/updated/
csourceSubscriptions/
csource-subscriptions-spec.json
View file @
8ef715db
...
...
@@ -23,7 +23,7 @@
"get"
:
{
"description"
:
"Retrieves the context source discovery subscriptions available in an NGSI-LD system"
,
"operationId"
:
"retrieveCSourceSubscriptions"
,
"tags"
:
[
"Context Sources"
],
"tags"
:
[
"Context Sources"
,
"CSourceSubscriptions"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/limit"
...
...
@@ -60,7 +60,7 @@
"post"
:
{
"description"
:
"Creates a context source discovery Subscription within an NGSI-LD system"
,
"operationId"
:
"createCSourceSubscription"
,
"tags"
:
[
"Context Sources"
],
"tags"
:
[
"Context Sources"
,
"CSourceSubscriptions"
],
"requestBody"
:
{
"required"
:
true
,
"content"
:
{
...
...
spec/updated/entities-spec.json
→
spec/updated/entities
/entities
-spec.json
View file @
8ef715db
...
...
@@ -130,7 +130,7 @@
"get"
:
{
"description"
:
"Retrieve a set of entities which matches a specific query from an NGSI-LD system"
,
"operationId"
:
"queryEntities"
,
"tags"
:
[
"Context Information"
],
"tags"
:
[
"Context Information"
,
"Entities"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/id"
...
...
@@ -200,7 +200,7 @@
"post"
:
{
"description"
:
"Create a new Entity within an NGSI-LD system"
,
"operationId"
:
"createEntity"
,
"tags"
:
[
"Context Information"
],
"tags"
:
[
"Context Information"
,
"Entities"
],
"requestBody"
:
{
"required"
:
true
,
"content"
:
{
...
...
spec/updated/entity-attrs-spec.json
→
spec/updated/
entities/
entity-attrs-spec.json
View file @
8ef715db
...
...
@@ -44,7 +44,7 @@
"post"
:
{
"description"
:
"Append new Entity attributes to an existing Entity within an NGSI-LD system"
,
"operationId"
:
"appendEntityAttrs"
,
"tags"
:
[
"Context Information"
],
"tags"
:
[
"Context Information"
,
"Entities"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/entityId"
...
...
@@ -72,7 +72,7 @@
"content"
:
{
"application/json;application/ld+json"
:
{
"schema"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#
/definitions/UpdateResult
"
}
}
}
...
...
@@ -102,7 +102,7 @@
"patch"
:
{
"description"
:
"Update existing Entity attributes within an NGSI-LD system"
,
"operationId"
:
"updateEntityAttrs"
,
"tags"
:
[
"Context Information"
],
"tags"
:
[
"Context Information"
,
"Entities"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/entityId"
...
...
@@ -127,7 +127,7 @@
"content"
:
{
"application/json;application/ld+json"
:
{
"schema"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#
/definitions/UpdateResult
"
}
}
}
...
...
@@ -159,7 +159,7 @@
"patch"
:
{
"description"
:
"Update existing Entity attributes within an NGSI-LD system"
,
"operationId"
:
"partialAttrUpdate"
,
"tags"
:
[
"Context Information"
],
"tags"
:
[
"Context Information"
,
"Entities"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/entityId"
...
...
@@ -207,7 +207,7 @@
"delete"
:
{
"description"
:
"Removes an existing Entity attribute within an NGSI-LD system"
,
"operationId"
:
"removeEntityAttr"
,
"tags"
:
[
"Context Information"
],
"tags"
:
[
"Context Information"
,
"Entities"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/entityId"
...
...
spec/updated/entity-by-id-spec.json
→
spec/updated/
entities/
entity-by-id-spec.json
View file @
8ef715db
...
...
@@ -42,7 +42,7 @@
"get"
:
{
"description"
:
"Retrieve an specific Entity from an NGSI-LD system. It's possible to specify the Entity attributes to be retrieved by using query parameters"
,
"operationId"
:
"retrieveEntityById"
,
"tags"
:
[
"Context Information"
],
"tags"
:
[
"Context Information"
,
"Entities"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/entityId"
...
...
@@ -54,7 +54,7 @@
"$ref"
:
"#/components/parameters/type"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/options"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/options"
}
],
"responses"
:
{
...
...
@@ -98,7 +98,7 @@
"delete"
:
{
"description"
:
"Removes an specific Entity from an NGSI-LD system"
,
"operationId"
:
"removeEntityById"
,
"tags"
:
[
"Context Information"
],
"tags"
:
[
"Context Information"
,
"Entities"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/entityId"
...
...
spec/updated/entity-operations-spec.json
→
spec/updated/
entities/
entity-operations-spec.json
View file @
8ef715db
...
...
@@ -6,11 +6,11 @@
},
"components"
:
{},
"paths"
:
{
"/entityOperations/create
/
"
:
{
"/entityOperations/create"
:
{
"post"
:
{
"description"
:
"Batch Entity creation"
,
"operationId"
:
"batchEntityCreation"
,
"tags"
:
[
"Batch Operations"
],
"tags"
:
[
"Batch Operations"
,
"Entities"
],
"requestBody"
:
{
"required"
:
true
,
"content"
:
{
...
...
@@ -45,11 +45,11 @@
}
}
},
"/entityOperations/update
/
"
:
{
"/entityOperations/update"
:
{
"post"
:
{
"description"
:
"Batch Entity update"
,
"operationId"
:
"batchEntityUpdate"
,
"tags"
:
[
"Batch Operations"
],
"tags"
:
[
"Batch Operations"
,
"Entities"
],
"parameters"
:
[
{
"name"
:
"options"
,
...
...
@@ -97,11 +97,11 @@
}
}
},
"/entityOperations/upsert
/
"
:
{
"/entityOperations/upsert"
:
{
"post"
:
{
"description"
:
"Batch Entity upsert"
,
"operationId"
:
"batchEntityUpsert"
,
"tags"
:
[
"Batch Operations"
],
"tags"
:
[
"Batch Operations"
,
"Entities"
],
"parameters"
:
[
{
"name"
:
"options"
,
...
...
@@ -150,11 +150,11 @@
}
}
},
"/entityOperations/delete
/
"
:
{
"/entityOperations/delete"
:
{
"post"
:
{
"description"
:
"Batch Entity delete"
,
"operationId"
:
"batchEntityDelete"
,
"tags"
:
[
"Batch Operations"
],
"tags"
:
[
"Batch Operations"
,
"Entities"
],
"requestBody"
:
{
"required"
:
true
,
"content"
:
{
...
...
spec/updated/generated/README.md
0 → 100644
View file @
8ef715db
>:warning: **Don't edit files in this folder, they are automatically generated and will be overwritten.**
\ No newline at end of file
spec/updated/full_api.json
→
spec/updated/
generated/
full_api.json
View file @
8ef715db
This diff is collapsed.
Click to expand it.
spec/updated/ngsi-ld-spec-open-api.json
View file @
8ef715db
...
...
@@ -48,46 +48,46 @@
],
"paths"
:
{
"/entities/"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/paths/%2Fentities%2F"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/paths/%2Fentities%2F"
},
"/entities/{entityId}"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/paths/%2Fentities%2F%7BentityId%7D"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/
entities/
entity-by-id-spec.json#/paths/%2Fentities%2F%7BentityId%7D"
},
"/entities/{entityId}/attrs/"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-attrs-spec.json#/paths/%2Fentities%2F%7BentityId%7D%2Fattrs%2F"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/
entities/
entity-attrs-spec.json#/paths/%2Fentities%2F%7BentityId%7D%2Fattrs%2F"
},
"/entities/{entityId}/attrs/{attrId}"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-attrs-spec.json#/paths/%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/
entities/
entity-attrs-spec.json#/paths/%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D"
},
"/subscriptions/"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/subscriptions-spec.json#/paths/%2Fsubscriptions%2F"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/subscriptions
/subscriptions
-spec.json#/paths/%2Fsubscriptions%2F"
},
"/subscriptions/{subscriptionId}"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/subscription-by-id-spec.json#/paths/%2Fsubscriptions%2F%7BsubscriptionId%7D"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/
subscriptions/
subscription-by-id-spec.json#/paths/%2Fsubscriptions%2F%7BsubscriptionId%7D"
},
"/csourceRegistrations/"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/csource-registrations-spec.json#/paths/%2FcsourceRegistrations%2F"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/
csourceRegistrations/
csource-registrations-spec.json#/paths/%2FcsourceRegistrations%2F"
},
"/csourceRegistrations/{registrationId}"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/csource-registration-by-id-spec.json#/paths/%2FcsourceRegistrations%2F%7BregistrationId%7D"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/
csourceRegistrations/
csource-registration-by-id-spec.json#/paths/%2FcsourceRegistrations%2F%7BregistrationId%7D"
},
"/csourceSubscriptions/"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/csource-subscriptions-spec.json#/paths/%2FcsourceSubscriptions%2F"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/
csourceSubscriptions/
csource-subscriptions-spec.json#/paths/%2FcsourceSubscriptions%2F"
},
"/csourceSubscriptions/{subscriptionId}"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/csource-subscription-by-id-spec.json#/paths/%2FcsourceSubscriptions%2F%7BsubscriptionId%7D"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/
csourceSubscriptions/
csource-subscription-by-id-spec.json#/paths/%2FcsourceSubscriptions%2F%7BsubscriptionId%7D"
},
"/entityOperations/create"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fcreate"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/
entities/
entity-operations-spec.json#/paths/%2FentityOperations%2Fcreate"
},
"/entityOperations/update"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fupdate"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/
entities/
entity-operations-spec.json#/paths/%2FentityOperations%2Fupdate"
},
"/entityOperations/upsert"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fupsert"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/
entities/
entity-operations-spec.json#/paths/%2FentityOperations%2Fupsert"
},
"/entityOperations/delete"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fdelete"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/
entities/
entity-operations-spec.json#/paths/%2FentityOperations%2Fdelete"
},
"/temporal/entities/"
:
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/paths/%2Ftemporal%2Fentities%2F"
...
...
spec/updated/subscription-by-id-spec.json
→
spec/updated/
subscriptions/
subscription-by-id-spec.json
View file @
8ef715db
...
...
@@ -22,8 +22,8 @@
"/subscriptions/{subscriptionId}"
:
{
"get"
:
{
"description"
:
"Retrieves a specific Subscription from an NGSI-LD system"
,
"operationId"
:
"retrieveSubscription"
,
"tags"
:
[
"Context Subscription"
],
"operationId"
:
"retrieveSubscription
ById
"
,
"tags"
:
[
"Context Subscription"
,
"Subscriptions"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/subscriptionId"
...
...
@@ -70,7 +70,7 @@
"patch"
:
{
"description"
:
"Updates a specific Subscription within an NGSI-LD system"
,
"operationId"
:
"updateSubscription"
,
"tags"
:
[
"Context Subscription"
],
"tags"
:
[
"Context Subscription"
,
"Subscriptions"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/subscriptionId"
...
...
@@ -115,7 +115,7 @@
"delete"
:
{
"description"
:
"Removes a specific Subscription from an NGSI-LD system"
,
"operationId"
:
"removeSubscription"
,
"tags"
:
[
"Context Subscription"
],
"tags"
:
[
"Context Subscription"
,
"Subscriptions"
],
"parameters"
:
[
{
"$ref"
:
"#/components/parameters/subscriptionId"
...
...
spec/updated/subscriptions-spec.json
→
spec/updated/subscriptions
/subscriptions
-spec.json
View file @
8ef715db
...
...
@@ -24,7 +24,8 @@
"description"
:
"Retrieves the subscriptions available in an NGSI-LD system"
,
"operationId"
:
"retrieveSubscriptions"
,
"tags"
:
[
"Context Subscription"
"Context Subscription"
,
"Subscriptions"
],
"parameters"
:
[
{
...
...
@@ -63,7 +64,8 @@
"description"
:
"Creates a new Subscription within an NGSI-LD system"
,
"operationId"
:
"createSubscription"
,
"tags"
:
[
"Context Subscription"
"Context Subscription"
,
"Subscriptions"
],
"requestBody"
:
{
"required"
:
true
,
...
...
spec/updated/temporal/temporal-entities-spec.json
View file @
8ef715db
...
...
@@ -74,34 +74,34 @@
"get"
:
{
"description"
:
"Query temporal evolution of Entities from an NGSI-LD system"
,
"operationId"
:
"queryTemporalEntities"
,
"tags"
:
[
"Temporal Evolution"
],
"tags"
:
[
"Temporal Evolution"
,
"Temporal"
],
"parameters"
:
[
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/id"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/id"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/idPattern"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/idPattern"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/type"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/type"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/attrs"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/attrs"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/q"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/q"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/georel"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/georel"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/geometry"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/geometry"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/coordinates"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/coordinates"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/geoproperty"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/geoproperty"
},
{
"$ref"
:
"#/components/parameters/timerel"
...
...
@@ -116,10 +116,10 @@
"$ref"
:
"#/components/parameters/endTime"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/csf"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/csf"
},
{
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/limit"
"$ref"
:
"https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities
/entities
-spec.json#/components/parameters/limit"
},
{
"$ref"
:
"#/components/parameters/options"
...
...
@@ -159,7 +159,7 @@
"post"
:
{
"description"
:
"Create or update temporal representation of an Entity within an NGSI-LD system"
,
"operationId"
:
"createUpdateEntityTemporal"
,
"tags"
:
[
"Temporal Evolution"
],
"tags"
:
[
"Temporal Evolution"
,
"Temporal"
],
"requestBody"
:
{
"required"
:
true
,
"content"
:
{
...
...
Prev
1
2
3
Next