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

Updating README file.

parent d7eef04b
Loading
Loading
Loading
Loading
+4 −7
Original line number Diff line number Diff line
@@ -2,10 +2,6 @@

This repository contains the OpenAPI Specification (OAS) for the NGSI-LD API specified by the cross-cutting Context Information Management (CIM) ETSI Industry Specification Group (ISG).

> **IMPORTANT NOTE:**
>
> This is a fork of the original OpenAPI Specification for the NGSI-LD API, which is available on the ETSI Forge [here](https://forge.etsi.org/rep/cim/NGSI-LD).

## Online Documentation

### Specification Document
@@ -14,9 +10,9 @@ This repository contains the OpenAPI Specification (OAS) for the NGSI-LD API spe

### Navigate API

* [Swagger UI](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/cim/NGSI-LD/-/raw/1.6.1/ngsi-ld-api.yaml)
* [Swagger Editor](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/cim/NGSI-LD/-/raw/1.6.1/ngsi-ld-api.yaml)
* [Redocly](https://redocly.github.io/redoc/?url=https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/-/raw/1.6.1/ngsi-ld-api.yaml)
* [Swagger UI](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/cim/ngsi-ld-openapi/-/raw/1.6.1/ngsi-ld-api.yaml)
* [Swagger Editor](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/cim/ngsi-ld-openapi/-/raw/1.6.1/ngsi-ld-api.yaml)
* [Redocly](https://redocly.github.io/redoc/?url=https://forge.etsi.org/rep/cim/ngsi-ld-openapi/-/raw/1.6.1/ngsi-ld-api.yaml)

## Developers

@@ -29,6 +25,7 @@ The NGSI-LD API specification has been developed using VS Code supported by the
The repository includes the following resources that may be useful when using the NGSI-LD API:
- [Core JSON-LD @context](./coreContext/): This folder contains JSON-LD core @context defined by the NGSI-LD API. For convencience, the folder includes @context files for different versions of the API.
- [NGSI-LD payload examples](./examples/): Includes examples of NGSI-LD payloads for multiple types of NGSI-LD operations. These examples can also be found in the Annex sections of the ETSI ISG CIM 009 document.
- [OpenAPI schemas compliant with NGSI-LD OAS](./examples/customSchemas/): Includes examples to show how to define custom OpenAPI schemas that are compatible with the NGSI-LD OAS. It allows developers to define specific-purpose applications where they model their own OpenAPI schemas, so they are compatible with the NGSI-LD meta-model defined within the NGSI-LD OAS.  

## License