Coveo

Coveo Atlassian Connect App API

The Atlassian Connect App API from Coveo — 3 operation(s) for atlassian connect app.

Documentation GitHub OpenAPI

Documentation

https://docs.coveo.com/en/124/

https://docs.coveo.com/en/365/

https://docs.coveo.com/en/56/

https://docs.coveo.com/en/3343/

https://docs.coveo.com/en/3265/

https://docs.coveo.com/en/1727/

https://docs.coveo.com/en/68/

https://docs.coveo.com/en/nbhe0427/

https://docs.coveo.com/en/52/

https://docs.coveo.com/en/2986/

https://docs.coveo.com/en/1719/

Specifications

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-atlassian-connect-app-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-passagev3-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restfacetrequest-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restfacetresult-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restfacetresultvalue-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restgroupby-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restgroupbyresult-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restgroupbyvalue-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-resthighlightresponse-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restquerycorrection-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryfunction-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryparameters-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryparentresult-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryresponse-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryresult-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restrankingfunction-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-retrievepassagesrequestv3-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-retrievepassagesresponsev3-schema.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-passagev3-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restfacetrequest-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restfacetresult-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restfacetresultvalue-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restgroupby-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restgroupbyresult-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restgroupbyvalue-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-resthighlightresponse-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restquerycorrection-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryfunction-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryparameters-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryparentresult-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryresponse-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryresult-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restrankingfunction-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-retrievepassagesrequestv3-structure.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-retrievepassagesresponsev3-structure.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-ld/coveo-commerce-context.jsonld

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/examples/coveo-search-querysuggestpostv3-example.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/examples/coveo-search-retrievepassagev3-example.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/examples/coveo-search-searchusingpost-example.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/examples/coveo-search-searchusingpostv3-example.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/examples/coveo-search-valuespost-example.json

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-ld/coveo-context.jsonld

https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-ld/coveo-analytics-context.jsonld

OpenAPI Specification

openapi: 3.0.1
info:
  title: Coveo Activity Activities Atlassian Connect App API
  description: API for Coveo Platform
  termsOfService: https://www.coveo.com/en/support/terms-agreements
  contact:
    name: Coveo
    url: https://connect.coveo.com/s/discussions
  version: 1.0.0
servers:
- url: https://platform.cloud.coveo.com
  description: Coveo public API endpoint
security:
- oauth2:
  - full
tags:
- name: Atlassian Connect App
paths:
  /rest/atlassian/connectapp/uninstalled:
    post:
      tags:
      - Atlassian Connect App
      operationId: removeConnectApp
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlassianHost'
        required: true
      responses:
        '200':
          description: OK
      x-pretty-name: removeConnectApp
      x-ui-operation-id: /rest/atlassian/connectapp/uninstalled_post
  /rest/atlassian/connectapp/installed:
    post:
      tags:
      - Atlassian Connect App
      operationId: addOrUpdateConnectApp
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlassianHost'
        required: true
      responses:
        '200':
          description: OK
      x-pretty-name: addOrUpdateConnectApp
      x-ui-operation-id: /rest/atlassian/connectapp/installed_post
  /rest/atlassian/connectapp/atlassian-connect.json:
    get:
      tags:
      - Atlassian Connect App
      operationId: atlassianConnectAppDescriptor
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppDescriptor'
      x-pretty-name: atlassianConnectAppDescriptor
      x-ui-operation-id: /rest/atlassian/connectapp/atlassian-connect.json_get
components:
  schemas:
    AtlassianHost:
      type: object
      properties:
        sharedSecret:
          type: string
        baseUrl:
          type: string
        productType:
          type: string
        appKey:
          type: string
    AppDescriptor:
      type: object
      properties:
        key:
          type: string
        name:
          type: string
        description:
          type: string
        baseUrl:
          type: string
        authentication:
          $ref: '#/components/schemas/Authentication'
        lifecycle:
          $ref: '#/components/schemas/Lifecycle'
        scopes:
          type: array
          items:
            type: string
        apiMigrations:
          $ref: '#/components/schemas/ApiMigrations'
        vendor:
          $ref: '#/components/schemas/Vendor'
    Authentication:
      type: object
      properties:
        type:
          type: string
    ApiMigrations:
      type: object
      properties:
        context-qsh:
          type: boolean
        signed-install:
          type: boolean
    Vendor:
      type: object
      properties:
        name:
          type: string
        url:
          type: string
    Lifecycle:
      type: object
      properties:
        installed:
          type: string
        uninstalled:
          type: string
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://platform.cloud.coveo.com/oauth/authorize
          tokenUrl: https://platform.cloud.coveo.com/oauth/token
          scopes:
            full: required