Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
backbone-message-format backbone-message-format
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 29
    • Issues 29
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge requests 5
    • Merge requests 5
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Metrics
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Package Registry
  • Analytics
    • Analytics
    • CI/CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Communications Backbone System
  • backbone-message-formatbackbone-message-format
  • Issues
  • #57

Closed
Open
Created Aug 21, 2024 by Dan Jones@danjonOwner

Make swagger output raw schema valid against openapi v3 spec

The JSON output from https://nucleus.noc.ac.uk/soar/protocol/latest/soar_protocol.json doesn't actually validate against the openapi v3 spec.

It's a minor thing but this output contains and empty definitions: {} object which isn't part of the openapi v3 spec and causes the validation of the specification itself to fail.

This means if we wire up the adapter protocol class to load the schema from here rather than from the committed file in gitlab we may have issues validating messages. It might be that validating messages with the invalid schema is fine and it's just validating the schema itself that fails.

There's a bug in flasgger which has been fixed but the fix has not been released.

The last release of flasgger was Aug 2020 This bug was fixed in Nov 2021 The latest pre-release version is from May 2023 Until the fix gets released we have to remove the invalid definitions object from the spec.

We could potentially just move to the pre-release beta version.

Assignee
Assign to
CB-2024W33
Milestone
CB-2024W33 (Past due)
Assign milestone
Time tracking