Skip to content

system_state_count description missing #221

Open
@uniqueg

Description

@uniqueg

It seems that the description for system_state_counts in the ServiceInfo model got inadvertently lost between 1.0.0 and 1.0.1 when migrating from Swagger/OpenAPI v2 to OpenAPI v3.

Since version 1.0.1:

components:
  schemas:
    ServiceInfo:
      title: ServiceInfo
      allOf:
        - $ref: 'https://raw.githubusercontent.com/ga4gh-discovery/ga4gh-service-info/v1.0.0/service-info.yaml#/components/schemas/Service'
        - type: object
          properties:
            ...
            system_state_counts:
              type: object
              additionalProperties:
                type: integer
                format: int64
            auth_instructions_url:
              ...

Note that the description is still available in the Swagger/OpenAPI 2 version of the specs that was dropped in the latest version v1.1.0.

Version 1.0.0:

definitions:
  ...
  ServiceInfo:
    type: object
    properties:
      ...
      system_state_counts:
        type: object
        additionalProperties:
          type: integer
          format: int64
        description: >-
          The system statistics, key is the statistic, value is the count of runs in that state.
          See the State enum for the possible keys.
      auth_instructions_url:
        ...

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions