Class: V1::AnnotationTypeResource

Inherits:

JSONAPI::Resource

• Object
• JSONAPI::Resource
• V1::AnnotationTypeResource

Defined in:

app/resources/v1/annotation_type_resource.rb

Overview

Note:

Access this resource via the /v1/annotation_types endpoint.

Provides a JSON:API representation of AnnotationType and exposes valid annotation types

For more information about JSON:API see the JSON:API Specifications or look at the JSONAPI::Resources package for the service implementation of the JSON:API standard.

Examples:

curl -X GET http://localhost:3000/v1/annotation_types
curl -X GET http://localhost:3000/v1/annotation_types/1

Instance Attribute Summary

• #name ⇒ String

  The name of the annotation type (required, max 50 chars).

Instance Attribute Details

#name ⇒ String

Returns the name of the annotation type (required, max 50 chars).

Returns:

• (String) —

  the name of the annotation type (required, max 50 chars)

# File 'app/resources/v1/annotation_type_resource.rb', line 20

attributes :name