Turn off string escaping and quotes transform

[vladshcherbin]

Hey 👋

Wondering if it's possible to skip string quotes and characters escape?

Simple example:

openapi: 3.1.1
info:
  title: Store API
  description: Welcome to the API Documentation! 🚀
  version: 1.0.0
servers:
  - url: https://test.com/api
    description: Production Server
tags:
  - name: Categories
    description: Operations for managing categories
paths:
  /categories:
    get:
      summary: Get Categories
      description: Retrieve a list of all categories available in the store, along with their details
      operationId: getAllCategories
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Category'
              example:
                - id: 1
                  name: Books
                  slug: books
      tags:
        - Categories
components:
  schemas:
    Category:
      description: Represents a category in the store
      type: object
      properties:
        id:
          description: Unique ID of the category
          type: integer
          example: 1
        name:
          description: Unique name of the category
          type: string
          example: Shoes
        slug:
          description: Unique URL-friendly identifier of the category
          type: string
          example: shoes
      required:
        - id
        - name
        - slug

Playground diff:

As you can see, description and url got transformed, even though they are perfectly valid ones.

I'm perfectly fine with sorting, just don't need my string to be wrapped with quotes and emoji transformed to something horror-like looking.

Maybe there's already an option to turn this off?

Thanks

openapi-format - 1.24.2

[thim81]

hi @vladshcherbin ,

We are using the "@stoplight/yaml" package to read/write YAML files.
We will have to investigate the options to prevent the quotes.

[thim81]

hi @vladshcherbin

https://www.npmjs.com/package/@stoplight/yaml does not provide options to control the string escaping or quotes.

In all honesty, I never noticed it, since it helped me to make sure the string were OK, by adding the quotes.
I typically, sort the OpenAPI documents which sets the " and that cleaned result becomes my new base document.

[vladshcherbin]

@thim81 that's quite unfortunate. I'd really prefer it clean and I also want my rocket 🚀 to shine bright, notice what the formatting did to it 😢

[thim81]

hi @vladshcherbin

I'll create an issue with @stoplight/yaml, using your example.
Lets see what suggestions they might propose.

[guilhas07]

Just putting the issue here for reference: stoplightio/yaml#78
It seems the repo doesn't have recent activity.

[thim81]

hi @vladshcherbin

Closing this long outstanding issue since thanks to the excellent contribution by @guilhas07, we have just released version 1.31.0 of openapi-format, which should be respecting the original YAML file content more and do less unnecessary quoting and string formatting.