marrbor / go-ngsiv2-api

go-ngsiv2-api

How To generate this

1. brew cask install homebrew/cask-versions/adoptopenjdk8
2. brew install swagger-codegen@2
3. /usr/local/opt/swagger-codegen@2/bin/swagger-codegen generate -l go -i https://fiware.github.io/specifications/OpenAPI/ngsiv2/ngsiv2-openapi.json

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

• API version: 1.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to http://orion.lab.fiware.org

Class	Method	HTTP request	Description
APIEntryPointApi	RetrieveAPIResources	Get /v2	Retrieve API Resources
AttributeValueApi	GetAttributeValue	Get /v2/entities/{entityId}/attrs/{attrName}/value	Get Attribute Value
AttributeValueApi	UpdateAttributeValue	Put /v2/entities/{entityId}/attrs/{attrName}/value	Update Attribute Value
AttributesApi	GetAttributeData	Get /v2/entities/{entityId}/attrs/{attrName}	Get attribute data
AttributesApi	RemoveASingleAttribute	Delete /v2/entities/{entityId}/attrs/{attrName}	Remove a Single Attribute
AttributesApi	UpdateAttributeData	Put /v2/entities/{entityId}/attrs/{attrName}	Update Attribute Data
BatchOperationsApi	Notify	Post /v2/op/notify	Notify
BatchOperationsApi	Query	Post /v2/op/query	Query
BatchOperationsApi	Update	Post /v2/op/update	Update
EntitiesApi	CreateEntity	Post /v2/entities	Create Entity
EntitiesApi	ListEntities	Get /v2/entities	List Entities
EntitiesApi	RemoveEntity	Delete /v2/entities/{entityId}	Remove Entity
EntitiesApi	ReplaceAllEntityAttributes	Put /v2/entities/{entityId}/attrs	Replace all entity attributes
EntitiesApi	RetrieveEntity	Get /v2/entities/{entityId}	Retrieve Entity
EntitiesApi	RetrieveEntityAttributes	Get /v2/entities/{entityId}/attrs	Retrieve Entity Attributes
EntitiesApi	UpdateExistingEntityAttributes	Patch /v2/entities/{entityId}/attrs	Update Existing Entity Attributes
EntitiesApi	UpdateOrAppendEntityAttributes	Post /v2/entities/{entityId}/attrs	Update or Append Entity Attributes
RegistrationsApi	CreateRegistration	Post /v2/registrations	Create Registration
RegistrationsApi	DeleteRegistration	Delete /v2/registrations/{registrationId}	Delete Registration
RegistrationsApi	ListRegistrations	Get /v2/registrations	List Registrations
RegistrationsApi	RetrieveRegistration	Get /v2/registrations/{registrationId}	Retrieve Registration
RegistrationsApi	UpdateRegistration	Patch /v2/registrations/{registrationId}	Update Registration
SubscriptionsApi	CreateSubscription	Post /v2/subscriptions	Create Subscription
SubscriptionsApi	DeleteSubscription	Delete /v2/subscriptions/{subscriptionId}	Delete subscription
SubscriptionsApi	ListSubscriptions	Get /v2/subscriptions	List Subscriptions
SubscriptionsApi	RetrieveSubscription	Get /v2/subscriptions/{subscriptionId}	Retrieve Subscription
SubscriptionsApi	UpdateSubscription	Patch /v2/subscriptions/{subscriptionId}	Update Subscription
TypesApi	ListEntityTypes	Get /v2/types/	List Entity Types
TypesApi	RetrieveEntityType	Get /v2/types/{entityType}	Retrieve entity type

Documentation For Models

• CreateEntityRequest
• CreateRegistrationRequest
• CreateSubscriptionRequest
• GetAttributeDataResponse
• GetAttributeValueResponse
• ListEntitiesResponse
• ListEntityTypesResponse
• ListRegistrationsResponse
• ListSubscriptionsResponse
• NotifyRequest
• Options
• Options10
• Options12
• Options20
• Options23
• Options3
• Options6
• QueryRequest
• QueryResponse
• ReplaceAllEntityAttributesRequest
• RetrieveApiResourcesResponse
• RetrieveEntityAttributesResponse
• RetrieveEntityResponse
• RetrieveEntityTypeResponse
• RetrieveRegistrationResponse
• UpdateAttributeDataRequest
• UpdateAttributeValueRequest
• UpdateExistingEntityAttributesRequest
• UpdateOrAppendEntityAttributesRequest
• UpdateRegistrationRequest
• UpdateRequest
• UpdateSubscriptionRequest

Documentation For Authorization

Endpoints do not require authorization.

Author