CrunchDAO

CrunchDAO competition:slice API

The competition:slice API from CrunchDAO — 4 operation(s) for competition:slice.

GitHub OpenAPI

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/crunchdao/refs/heads/main/authentication/crunchdao-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/crunchdao/refs/heads/main/openapi/crunchdao-competition-slice-api-openapi.yml

Other Resources

🔗
Swagger
https://api.hub.crunchdao.com/swagger-ui/index.html
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/crunchdao/refs/heads/main/conventions/crunchdao-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/crunchdao/refs/heads/main/errors/crunchdao-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/crunchdao/refs/heads/main/lifecycle/crunchdao-lifecycle.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/crunchdao/refs/heads/main/data-model/crunchdao-data-model.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/crunchdao/refs/heads/main/conformance/crunchdao-conformance.yml

OpenAPI Specification

crunchdao-competition-slice-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Tournament activity competition:slice API
  description: CrunchDAO Tournament Platform API Endpoints
  version: v2
servers:
- url: http://api.hub.crunchdao.com
  description: Generated server url
security: []
tags:
- name: competition:slice
paths:
  /v1/competitions/{competitionIdentifier}/slices:
    x-service-id: competition-service
    get:
      tags:
      - competition:slice
      operationId: listCompetitionSlices
      parameters:
      - name: competitionIdentifier
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: locale
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - ENGLISH
          - CHINESE
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Slice'
    post:
      tags:
      - competition:slice
      operationId: createCompetitionSlice
      parameters:
      - name: competitionIdentifier
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: locale
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - ENGLISH
          - CHINESE
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SliceCreateForm'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Slice'
      security:
      - accessToken: []
      - apiKey: []
  /v1/competitions/{competitionIdentifier}/slices/~/import/markdown:
    x-service-id: competition-service
    post:
      tags:
      - competition:slice
      operationId: importCompetitionSlicesFromMarkdown
      parameters:
      - name: competitionIdentifier
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: locale
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - ENGLISH
          - CHINESE
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SliceMarkdownImportForm'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: integer
                format: int32
      security:
      - accessToken: []
      - apiKey: []
  /v1/competitions/{competitionIdentifier}/slices/~/import/gitbook:
    x-service-id: competition-service
    post:
      tags:
      - competition:slice
      operationId: importCompetitionSlicesFromGitBook
      parameters:
      - name: competitionIdentifier
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SliceGitBookImportForm'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: integer
                format: int32
      security:
      - accessToken: []
      - apiKey: []
  /v1/competitions/{competitionIdentifier}/slices/{sliceName}:
    x-service-id: competition-service
    get:
      tags:
      - competition:slice
      operationId: getCompetitionSlice
      parameters:
      - name: competitionIdentifier
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: sliceName
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: locale
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - ENGLISH
          - CHINESE
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Slice'
    delete:
      tags:
      - competition:slice
      operationId: deleteCompetitionSlice
      parameters:
      - name: competitionIdentifier
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: sliceName
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: locale
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - ENGLISH
          - CHINESE
      responses:
        '202':
          description: Accepted
      security:
      - accessToken: []
      - apiKey: []
    patch:
      tags:
      - competition:slice
      operationId: updateCompetitionSlice
      parameters:
      - name: competitionIdentifier
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: sliceName
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: locale
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - ENGLISH
          - CHINESE
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SliceUpdateForm'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Slice'
      security:
      - accessToken: []
      - apiKey: []
components:
  schemas:
    SliceMarkdownImportForm:
      type: object
      properties:
        markdown:
          type: string
      required:
      - markdown
    SliceGitBookImportForm:
      type: object
      properties:
        url:
          type: string
        changeRequestNumber:
          type: integer
          format: int64
        titleLevel:
          type: string
          enum:
          - PRIMARY
          - SECONDARY
        append:
          type: boolean
      required:
      - append
      - titleLevel
      - url
    SliceCreateForm:
      type: object
      properties:
        name:
          type: string
        displayName:
          type: string
        type:
          type: string
          enum:
          - CONTENT
          - KEY_METRICS
          - TIMELINE
          - TEAM
        nativeConfiguration:
          type: string
        order:
          type: integer
          format: int64
      required:
      - name
      - nativeConfiguration
      - order
      - type
    Slice:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
          description: Slug-like name.
        displayName:
          type: string
          description: Display name/title for cards.
        type:
          $ref: '#/components/schemas/SliceType'
        nativeConfiguration:
          type: string
          description: Native frontend configuration for the chart.
        order:
          type: integer
          format: int64
          description: Page order.
        updatedAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
    SliceType:
      type: string
      enum:
      - CONTENT
      - KEY_METRICS
      - TIMELINE
      - TEAM
    SliceUpdateForm:
      type: object
      properties:
        name:
          type: string
        displayName:
          type: string
        type:
          type: string
          enum:
          - CONTENT
          - KEY_METRICS
          - TIMELINE
          - TEAM
        nativeConfiguration:
          type: string
        order:
          type: integer
          format: int64
  securitySchemes:
    apiKey:
      type: apiKey
      name: apiKey
      in: query
      scheme: token
    accessToken:
      type: http
      in: header
      scheme: Bearer
externalDocs:
  description: docs.crunchdao.com
  url: https://docs.crunchdao.com