Skip to content
GitLab
Next
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • GitLab GitLab
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 44,761
    • Issues 44,761
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 1,332
    • Merge requests 1,332
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • GitLab.orgGitLab.org
  • GitLabGitLab
  • Issues
  • #330583
Closed
Open
Issue created May 11, 2021 by Seth Berger@sethgitlabDeveloper11 of 11 checklist items completed11/11 checklist items

Support YAML files for OpenAPI Specs

Problem

According to the OpenAPI specification a openapi definition can be defined in yaml or json. However API fuzzing only accepts a json format.

The swagger online editor can easily convert from json to yaml, but defaults to YAML. Users may prefer to work in YAML as a result.

Proposal

Allow a user to specify the specification in YAML or JSON format.

Tasks:

  1. Verify NSwag library supports yaml
  2. Update validation performed by worker-entry to support yaml for OpenAPI specifications
  3. Update runner as needed to support yaml for OpenAPI
  4. Testing
    1. Add unit tests for runner in c#
      1. OpenAPI YAML for v2.0, v3.0
    2. Add integration test for worker-entry that uses yaml
      1. OpenAPI YAML for v2.0, v3.0 (using UTF-8-BOM)
    3. Add e2e test that uses yaml
      1. openapi-v2-yaml
      2. openapi-v3-yaml
  5. Publish new container
  6. Update documentation to reflect either format is supported. MR !61751 (merged)
    1. API Fuzzing
    2. DAST API

MR !508

Edited May 20, 2021 by Michael Eddington
Assignee
Assign to
Time tracking