swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Entries API
schemes:
- https
tags:
- name: Entries
paths:
  /entries:
    post:
      operationId: microsoftAzureCreateentry
      description: Post an entry to be registered on the CodeTransparency instance.
      consumes:
      - application/cose
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/CoseEntry.body'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/CreateEntryResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        CreateEntry:
          $ref: ./examples/CreateEntry.json
      summary: Microsoft Azure Post Entries
      tags:
      - Entries
  /entries/{entryId}:
    get:
      operationId: microsoftAzureGetentry
      description: Get Entry with or without receipt embedded in its unprotected header
      produces:
      - application/cose
      - application/json
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/EmbedReceiptParameter.embedReceipt'
      - $ref: '#/parameters/EntryIdParameter'
      responses:
        '200':
          description: An Entry in Cose format
          schema:
            type: file
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        GetEntry:
          $ref: ./examples/GetEntry.json
      summary: Microsoft Azure Get Entries Entryid
      tags:
      - Entries
  /entries/{entryId}/receipt:
    get:
      operationId: microsoftAzureGetentryreceipt
      description: Get the receipt of an entry given a specific entry id.
      produces:
      - application/cbor
      - application/json
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/EntryIdParameter'
      responses:
        '200':
          description: A Raw Entry in cbor format
          schema:
            type: file
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        GetEntryReceipt:
          $ref: ./examples/GetEntryReceipt.json
      summary: Microsoft Azure Get Entries Entryid Receipt
      tags:
      - Entries
  /entries/txIds:
    get:
      operationId: microsoftAzureListentryids
      description: Historical query to get a list of entries of a given range
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/TransactionsRange.from'
      - $ref: '#/parameters/TransactionsRange.to'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/EntryIds'
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/ServiceUnavailableError'
          headers:
            Retry-After:
              type: string
              description: Retry the same request after a suggested number of seconds
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
          x-ms-error-response: true
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        ListEntryIds:
          $ref: ./examples/ListEntryIds.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Entries Txids
      tags:
      - Entries
definitions:
  ServiceUnavailableError:
    type: object
    description: Service temporarily unavailable
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
    - error
  EntryIds:
    type: object
    description: A List of Entry IDs
    properties:
      transactionIds:
        type: array
        description: List of entry ids
        items:
          type: string
      nextLink:
        type: string
        description: Path to the next page of results
    required:
    - transactionIds
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing error details.
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
    - error
  Azure.Core.Foundations.InnerError:
    type: object
    description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: Inner error.
  CreateEntryResult:
    type: object
    description: Response of entry submission containing the operationId.
    properties:
      operationId:
        type: string
        description: String representing the operation id submitted
        pattern: ^[0-9]+\.[0-9]+$
    required:
    - operationId
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
parameters:
  TransactionsRange.from:
    name: from
    in: query
    description: Starting Transaction Id
    required: false
    type: integer
    format: int64
    minimum: 0
    x-ms-parameter-location: method
  CoseEntry.body:
    name: body
    in: body
    description: A raw CoseSign1 signature
    required: true
    schema:
      type: string
      format: binary
    x-ms-parameter-location: method
  TransactionsRange.to:
    name: to
    in: query
    description: Ending Transaction Id
    required: false
    type: integer
    format: int64
    minimum: 0
    x-ms-parameter-location: method
  Azure.Core.Foundations.ApiVersionParameter:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
  EmbedReceiptParameter.embedReceipt:
    name: embedReceipt
    in: query
    description: Embed a receipt as part of the response
    required: false
    type: boolean
    default: false
    x-ms-parameter-location: method
  EntryIdParameter:
    name: entryId
    in: path
    description: ID of the entry to retrieve.
    required: true
    type: string
    pattern: ^[0-9]+\.[0-9]+$
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'