APIVersions.APIVersion (Requirement Yogi 3.0.0 API)

java.lang.Object
- java.lang.Enum<APIVersions.APIVersion>
- - com.playsql.utils.sharedbeans.APIVersions.APIVersion

All Implemented Interfaces:

Serializable, Comparable<APIVersions.APIVersion>

Enclosing class:

APIVersions
```
public static enum APIVersions.APIVersion
extends Enum<APIVersions.APIVersion>
```
The details of each API version

Enum Constant Summary

Enum Constants
Enum Constant and Description
`V0` No plugin installed on the Jira side, we created RILs directly.
`V1` Queue between Jira and Confluence
`V10` In 2.6.5, we'll make it possible to delete and restore requirements just by keeping a flag in Jira, so it doesn't destroy the links, and so they can be restored.
`V2` Queue is sent with a centralized user Introduced GET jira/.../api which returns JSON.
`V3` Queue is sent with a centralized user (with different field names) OutboundQueueMessage#authorKey and OutboundQueueMessage#authorName are mandatory.
`V4` Queue can reset requirements both ways.
`V5` Jira bulk issue creation.
`V6` Queue in Jira (with a username, where a username is required in the Jira administration) (jira)/rest/reqs/1/api also returns applink.api_authenticated_user if a username has properly been set in the administration
`V7` We've added a few properties returned by both APIs so it is easier to connect on both sides.
`V8` In 2.5.18, we've noticed it could take 4 minutes to retrieve the list of custom fields, so we've added a REST API which can retrieve a subset of them.
`V9` In 2.6.3, we've added a way to search for baselines and spaces in Confluence.

Field Summary

Fields
Modifier and Type Field and Description

private String description

private String label

private Integer version

Fields
Modifier and Type	Field and Description
`private String`	`description`
`private String`	`label`
`private Integer`	`version`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDescription()`
`String`	`getLabel()`
`int`	`getVersion()`
`boolean`	`isSupported(Integer version)` Returns true if the version passed in the argument supports this enum's version.
`static APIVersions.APIVersion`	`safeValueOf(Integer version)`
`static APIVersions.APIVersion`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static APIVersions.APIVersion[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - V0
```
public static final APIVersions.APIVersion V0
```
    No plugin installed on the Jira side, we created RILs directly. It can't be used anymore with RY.
  - V1
```
public static final APIVersions.APIVersion V1
```
    Queue between Jira and Confluence
  - V2
```
public static final APIVersions.APIVersion V2
```
    Queue is sent with a centralized user Introduced GET jira/.../api which returns JSON. This was a temporary version in 2.2.0 where Confluence would send messages with an 'author' field. Never used on the Jira side.
    
    Since:
    
    2.2.0
  - V3
```
public static final APIVersions.APIVersion V3
```
    Queue is sent with a centralized user (with different field names) OutboundQueueMessage#authorKey and OutboundQueueMessage#authorName are mandatory. Introduced PUT jira/.../api/{applinkId}/version
    
    Since:
    
    2.2.1
  - V4
```
public static final APIVersions.APIVersion V4
```
    Queue can reset requirements both ways. QueueMessage.InboundQueueMessage.InEvent#RESET_REQUIREMENT is introduced in order to remove all Jira links for a certain requirement.
    
    Since:
    
    RY 2.2.4
  - V5
```
public static final APIVersions.APIVersion V5
```
    Jira bulk issue creation. Support for (jira)/rest/api/1/operations/{applinkId}/issues-bulk-operation and all subresources.
    
    Since:
    
    RY 2.3.2
  - V6
```
public static final APIVersions.APIVersion V6
```
    Queue in Jira (with a username, where a username is required in the Jira administration) (jira)/rest/reqs/1/api also returns applink.api_authenticated_user if a username has properly been set in the administration
    
    Since:
    
    RY 2.4.6
  - V7
```
public static final APIVersions.APIVersion V7
```
    We've added a few properties returned by both APIs so it is easier to connect on both sides. (confluence)/rest/reqs/1/integration can be used with ?url=.. (confluence)/rest/reqs/1/integration/{id} returns new properties: - info_is_remote_user_valid, - info_logged_as_userkey, - info_logged_as_username, - info_logged_as_userfullname
    
    Since:
    
    RY 2.5.0
  - V8
```
public static final APIVersions.APIVersion V8
```
    In 2.5.18, we've noticed it could take 4 minutes to retrieve the list of custom fields, so we've added a REST API which can retrieve a subset of them. Also: - In 2.6.1, we've added the "timeout" param to Jira's POST /api calls, - In 2.6.2, we've added the "timeout" param to Confluence's POST /queue/inbound
  - V9
```
public static final APIVersions.APIVersion V9
```
    In 2.6.3, we've added a way to search for baselines and spaces in Confluence. See /rest/reqs/1/baseline?q=some_query
  - V10
```
public static final APIVersions.APIVersion V10
```
    In 2.6.5, we'll make it possible to delete and restore requirements just by keeping a flag in Jira, so it doesn't destroy the links, and so they can be restored. It is much better in case someone temporarily pastes a draft in Confluence, saves and transforms the links after insertion.
- Field Detail
  - version
```
private final Integer version
```
  - label
```
private final String label
```
  - description
```
private final String description
```
- Method Detail
  - values
```
public static APIVersions.APIVersion[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (APIVersions.APIVersion c : APIVersions.APIVersion.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static APIVersions.APIVersion valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - safeValueOf
```
public static APIVersions.APIVersion safeValueOf(Integer version)
```
  - getVersion
```
public int getVersion()
```
  - getLabel
```
public String getLabel()
```
  - getDescription
```
public String getDescription()
```
  - isSupported
```
public boolean isSupported(Integer version)
```
    Returns true if the version passed in the argument supports this enum's version.

Enum APIVersions.APIVersion

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

V0

V1

V2

V3

V4

V5

V6

V7

V8

V9

V10

Field Detail

version

label

description

Method Detail

values

valueOf

safeValueOf

getVersion

getLabel

getDescription

isSupported