Link¶
Example Json Object
1{
2 "href": "string",
3 "hreflang": "string",
4 "title": "string",
5 "type": "string",
6 "deprecation": "string",
7 "profile": "string",
8 "name": "string",
9 "templated": true
10}
📄 Description: Data transfer object representing a hyperlink that connects various resources within the application, facilitating seamless navigation and integration of related content for enhanced user experience.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
href |
string |
false |
none |
URL reference that provides access to the related resource within the API, facilitating seamless navigation and integration. |
hreflang |
string |
false |
none |
The hreflang field specifies the language and regional targeting of a webpage, enhancing search engine optimization and improving user experience by directing users to the appropriate content based on their language preferences. |
title |
string |
false |
none |
Title of the resource |
type |
string |
false |
none |
Type of the resource |
deprecation |
string |
false |
none |
Indicates the status of the API field’s deprecation, providing essential information for users to understand its lifecycle and potential replacement. |
profile |
string |
false |
none |
Represents the URL link to the user’s profile, facilitating easy access to their personal information and settings within the application. |
name |
string |
false |
none |
Name of the resource |
templated |
boolean |
false |
none |
Indicates whether the associated resource is based on a predefined template, facilitating standardized processes and consistency across implementations. |