Commit a4b3596e authored by daniel-gonzalez-sanchez's avatar daniel-gonzalez-sanchez
Browse files

Fixing some issues within the NGSI-OAS v1.6.1 regarding Context Information... 

Fixing some issues within the NGSI-OAS v1.6.1 regarding Context Information Consumption operations: 1) Fixing tags section for 5.8.3-Retrieve Subscription y 5.8.4-Query Subscriptions to Context Information Subscription; 2) Including description of 5.7.6-Retrieve Details of Available Entity Types operation together with the 5.7.5-Retrieve Available Entity Types operation; 3) Including description of 5.7.9-Retrieve Details of Available Attributes operation together with the 5.7.8-Retrieve Available Attributes operation; 4) Fixing the EntityTypeList type definition within schema content of the response for 5.7.5-Retrieve Available Entity Types operation and 5.7.6-Retrieve Details of Available Entity Types operations. Pending actions: solving doubts with the definition of the parameters Query.geometryProperty, Query.geoproperty, and Query.options.entities, and Query.datasetId.
parent 3ba1f8b4

ngsi-ld-api.yaml

+31 −19
Original line number Diff line number Diff line
@@ -189,7 +189,9 @@ paths: 
        - $ref: '#/components/parameters/Path.entityId'

        # Query params

        - $ref: '#/components/parameters/Query.attrs'

        # REVIEW GeoProperty

        - $ref: '#/components/parameters/Query.geometryProperty'

        # REVIEW Options entities

        - $ref: '#/components/parameters/Query.lang'

        - $ref: '#/components/parameters/Query.options.entities'

        # Local Query param
@@ -923,7 +925,7 @@ paths: 
          $ref: '#/components/responses/Conflict'

    get:

      tags:

        - Context Information Consumption

        - Context Information Subscription

      summary: |

        Retrieve list of Subscriptions

      description: |
@@ -979,7 +981,7 @@ paths: 
  /subscriptions/{subscriptionId}:

    get:

      tags:

        - Context Information Consumption

        - Context Information Subscription

      summary: |

        Subscription retrieval by id

      description: |
@@ -1653,7 +1655,7 @@ paths: 
      summary: |

        Query entities based on POST

      description: |

        5.7.2 Query Entity.

        5.7.2 Query Entities (batch entity queries only).

      operationId: queryBatch

      parameters:

        # Local Query param
@@ -1777,7 +1779,7 @@ paths: 
      summary: |

        Temporal Representation of Entity creation

      description: |

        5.6.11 Upsert Temporal Representation.

        5.6.11 Create or Update Temporal Representation of an Entity.



        This operation allows creating or updating (by adding new Attribute instances)

        a Temporal Representation of an Entity.
@@ -1992,7 +1994,7 @@ paths: 
      summary: |

        Temporal Representation of Entity Attribute instance addition

      description: |

        5.6.12 Append Entity Attributes.

        5.6.12 Add Attributes to Temporal Representation of an Entity.



        This operation allows modifying a Temporal Representation of an Entity by adding new Attribute instances.

      operationId: appendAttrsTemporal
@@ -2187,13 +2189,18 @@ paths: 
      tags:

        - Context Information Consumption

      summary: |

        Retrieve available entity types

        Retrieve Available Entity Types & Retrieve Details of Available Entity Types 

      description: |

        5.7.5 Retrieve Available Entity Types.



        This operation allows retrieving a list of NGSI-LD entity types for which

        entity instances exist within the NGSI-LD system.

      operationId: retrieveTypes



        5.7.6  Retrieve Details of Available Entity Types.



        This operation allows retrieving a list with a detailed representation of

        NGSI-LD entity types for which entity instances exist within the NGSI-LD system.

      operationId: retrieveEntityTypes

      parameters:

        # Query params

        - name: details
@@ -2226,9 +2233,7 @@ paths: 
            application/json:

              schema:

                oneOf:

                  - type: array

                    items:

                      $ref: '#/components/schemas/EntityTypeList'

                  - $ref: '#/components/schemas/EntityTypeList'

                  - type: array

                    items:

                      $ref: '#/components/schemas/EntityType'
@@ -2242,9 +2247,7 @@ paths: 
                      properties:

                        '@context':

                          $ref:  '#/components/schemas/LdContext'

                    - type: array

                      items:

                        $ref: '#/components/schemas/EntityTypeList'

                    - $ref: '#/components/schemas/EntityTypeList'

                  - allOf:

                    - type: object

                      required:
@@ -2312,12 +2315,17 @@ paths: 
      tags:

        - Context Information Consumption

      summary: |

        Retrieve Available Attributes

        Retrieve Available Attributes & Retrieve Details of Available Attributes

      description: |

        5.7.8 Retrieve Available attributes.

        5.7.8 Retrieve Available Attributes.



        This operation allows retrieving a list of NGSI-LD attributes that belong to

        entity instances existing within the NGSI- LD system.



        5.7.9 Retrieve Details of Available Attributes.



        This operation allows retrieving a list with a detailed representation of NGSI-LD 

        attributes that belong to entity instances existing within the NGSI-LD system.

      operationId: retrieveAttributes

      parameters:

        # Query params
@@ -2385,7 +2393,7 @@ paths: 
      summary: |

        Retrieve Available Attribute Information

      description: |

        5.7.10 Retrieve Available Attribute information.

        5.7.10 Retrieve Available Attribute Information.



        This operation allows retrieving detailed attribute information about a specified NGSI-LD attribute

        that belongs to entity instances existing within the NGSI-LD system. The detailed representation includes
@@ -2840,6 +2848,7 @@ components: 
      schema:

        type: string

      required: false

    # REVIEW

    Query.datasetId:

      name: datasetId

      in: query
@@ -2906,6 +2915,7 @@ components: 
        type: string

        format: pattern

      required: false

    # REVIEW (5.7.1 y 6.4.3/6.5.3)

    Query.geometryProperty:

      name: geometryProperty

      in: query
@@ -2934,6 +2944,7 @@ components: 
            - Polygon

            - MultiPolygon

        required: false

    # REVIEW (5.7.1 y 6.4.3/6.5.3)

    Query.geoproperty:

      name: geoproperty

      in: query
@@ -3036,6 +3047,7 @@ components: 
        type: string

        format: date-time

      required: false

    # REVIEW

    Query.options.entities:

      name: options

      in: query