...

Source file src/github.com/ory/x/healthx/doc.go

Documentation: github.com/ory/x/healthx

     1  /*
     2   * Copyright © 2015-2018 Aeneas Rekkas <aeneas+oss@aeneas.io>
     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   *
    16   * @author		Aeneas Rekkas <aeneas+oss@aeneas.io>
    17   * @copyright 	2015-2018 Aeneas Rekkas <aeneas+oss@aeneas.io>
    18   * @license 	Apache-2.0
    19   */
    20  
    21  // Package healthx providers helpers for returning health status information via HTTP.
    22  package healthx
    23  
    24  // swagger:model healthStatus
    25  type swaggerHealthStatus struct {
    26  	// Status always contains "ok".
    27  	Status string `json:"status"`
    28  }
    29  
    30  // swagger:model healthNotReadyStatus
    31  type swaggerNotReadyStatus struct {
    32  	// Errors contains a list of errors that caused the not ready status.
    33  	Errors map[string]string `json:"errors"`
    34  }
    35  
    36  // swagger:model version
    37  type swaggerVersion struct {
    38  	// Version is the service's version.
    39  	Version string `json:"version"`
    40  }
    41  

View as plain text