Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

system_state_count description missing #221

Open
uniqueg opened this issue Sep 28, 2024 · 0 comments · May be fixed by #222
Open

system_state_count description missing #221

uniqueg opened this issue Sep 28, 2024 · 0 comments · May be fixed by #222

Comments

@uniqueg
Copy link
Contributor

uniqueg commented Sep 28, 2024

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:
        ...
@uniqueg uniqueg linked a pull request Sep 28, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: readd system state count description ga4gh/workflow-execution-service-schemas
1 participant
@uniqueg