...

Text file src/github.com/sigstore/timestamp-authority/openapi.yaml

Documentation: github.com/sigstore/timestamp-authority

     1#
     2# Copyright 2022 The Sigstore Authors.
     3#
     4# Licensed under the Apache License, Version 2.0 (the "License");
     5# you may not use this file except in compliance with the License.
     6# You may obtain a copy of the License at
     7#
     8#     http://www.apache.org/licenses/LICENSE-2.0
     9#
    10# Unless required by applicable law or agreed to in writing, software
    11# distributed under the License is distributed on an "AS IS" BASIS,
    12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13# See the License for the specific language governing permissions and
    14# limitations under the License.
    15
    16swagger: "2.0"
    17info:
    18  title: Timestamp Authority
    19  description: Timestamp Authority provides an RFC3161 timestamp authority.
    20  version: 0.0.1
    21
    22host: timestamp.sigstore.dev
    23schemes:
    24  - http
    25
    26paths:
    27  /api/v1/timestamp:
    28    post:
    29      summary: Generates a new timestamp response and creates a new log entry for the timestamp in the transparency log
    30      operationId: getTimestampResponse
    31      tags:
    32        - timestamp
    33      consumes:
    34        - application/timestamp-query
    35        - application/json
    36      produces:
    37        - application/timestamp-reply
    38      parameters:
    39        - in: body
    40          name: request
    41          required: true
    42          schema:
    43            type: string
    44            format: binary
    45      responses:
    46        201:
    47          description: Returns a timestamp response and the location of the log entry in the transprency log
    48          schema:
    49            type: string
    50            format: binary
    51        400:
    52          $ref: '#/responses/BadContent'
    53        501:
    54          $ref: '#/responses/NotImplemented'
    55        default:
    56          $ref: '#/responses/InternalServerError'
    57
    58  /api/v1/timestamp/certchain:
    59    get:
    60      summary: Retrieve the certificate chain for timestamping that can be used to validate trusted timestamps
    61      description: Returns the certificate chain for timestamping that can be used to validate trusted timestamps
    62      operationId: getTimestampCertChain
    63      tags:
    64        - timestamp
    65      consumes:
    66        - application/json
    67      produces:
    68        - application/pem-certificate-chain
    69      responses:
    70        200:
    71          description: The PEM encoded cert chain
    72          schema:
    73            type: string
    74        404:
    75          $ref: '#/responses/NotFound'
    76        default:
    77          $ref: '#/responses/InternalServerError'
    78
    79definitions:
    80  Error:
    81    type: object
    82    properties:
    83      code:
    84        type: integer
    85      message:
    86        type: string
    87
    88responses:
    89  BadContent:
    90    description: The content supplied to the server was invalid
    91    schema:
    92      $ref: "#/definitions/Error"
    93  NotFound:
    94    description: The content requested could not be found
    95  NotImplemented:
    96    description: The content requested is not implemented
    97  InternalServerError:
    98    description: There was an internal error in the server while processing the request
    99    schema:
   100      $ref: "#/definitions/Error"

View as plain text