Support Jira Insight

[Fank]

Jira bought "Insight" a longer time ago and added it to there Cloud APIs using the same authentication methods:

Authentication: For authenticating directly against the REST API, the Insight in Jira Service Management REST API supports basic auth (see Basic auth for REST APIs). Reference https://developer.atlassian.com/cloud/insight/intro/introduction-and-basics/

Additional context

REST Documentation: https://developer.atlassian.com/cloud/insight/rest/

Implemented API

Icon:

• [x] GET /icon/{id}
• [x] GET /icon/global

Import:

• [ ] POST /import/start/{id}

Iql:

• [x] GET /iql/objects

Object:

• [x] GET /objects/{id}
• [x] PUT /objects/{id}
• [x] DELETE /objects/{id}
• [x] GET /objects/{id}/attributes
• [x] GET /objects/{id}/history
• [x] GET /objects/{id}/referenceinfo
• [x] POST /objects/create
• [x] POST /objects/navlist/iql

Objectconnectedtickets:

• [ ] GET /objectconnectedtickets/{objectId}/tickets

Objectschema:

• [x] GET /objectschema/list
• [x] POST /objectschema/create
• [x] GET /objectschema/{id}
• [x] PUT /objectschema/{id}
• [x] DELETE /objectschema/{id}
• [x] GET /objectschema/{id}/attributes
• [x] GET /objectschema/{id}/objecttypes/flat

Objecttype:

• [x] GET /objecttype/list
• [x] PUT /objecttype/{id}
• [x] DELETE /objecttype/{id}
• [x] GET /objecttype/{id}/attributes
• [x] POST /objecttype/{id}/position
• [x] POST /objecttype/create

Objecttypeattribute:

• [ ] POST /objecttypeattribute/{objectTypeId}
• [ ] PUT /objecttypeattribute/{objectTypeId}/{id}
• [ ] DELETE /objecttypeattribute/{id}

Progress:

• [ ] GET /progress/category/import/{id}

Config:

• [ ] GET /config/statustype
• [ ] POST /config/statustype
• [ ] GET /config/statustype/{id}
• [ ] PUT /config/statustype/{id}
• [ ] DELETE /config/statustype/{id}

Global:

• [ ] POST /global/config/objectschema/{id}/property

[andygrunwald]

See https://gitlab.com/mclgmbh/golang-pkg/jira-insight/-/blob/main/insight/api.go

[Fank]

@andygrunwald While implementing #565 i noticed that all endpoints require a workspace id. So I came up with some ideas right now, should we go for:

1.

client := NewClient(...)
client.Insight.ObjectType.GetAttributes("MyWorkspaceID", "ID")

2.

client := NewClient(...)
client.Insight("MyWorkspaceID").ObjectType.GetAttributes("ID")

3.

client := NewClient(...)
client.Insight.ObjectType.GetAttributes("MyWorkspaceID", "ID")

client2 := NewClient(...)
client2.InsightWithWorkspace("MyWorkspaceID").ObjectType.GetAttributes("ID")
// which is a wrapper for
// client2.Insight.ObjectType.GetAttributes("MyWorkspaceID", "ID")
// so you can do something like:

insight := client2.InsightWithWorkspace("MyWorkspaceID")
insight.ObjectType.Get("ID")
insight.ObjectType.GetAttributes("ID")
...

[andygrunwald]

Personally, I am in favor of option 1, because

• it is pretty easy to understand from a caller perspective
• the library might end up being more simple due to no logic to "hold" the workspace id
• it fits other areas of the library (e.g., where kanban or sprint id needs to be added)