sanitize command #46

Activity

1. simplesagar

   assigned

   TristanSpeakEasy

   on Sep 9, 2025
2. TristanSpeakEasy commented on Sep 9, 2025

   

   TristanSpeakEasy

   on Sep 9, 2025

   Member

   More actions

   Hey @zdunecki do you have an example document and a list of the things you would like it to deal with?

   When you mention x-go is that an extension you have in your document? That you want removed?
3. zdunecki commented on Sep 9, 2025

   

   zdunecki

   on Sep 9, 2025

   Last edited by zdunecki

   Author

   More actions

   It would be awesome to have control over what should be sanitized.

   Yes, I'm using x-go-<name> extensions for a server codegen, but as a client, it's useful and sometimes necessary to delete some parts of OpenAPI spec.

   I think it may be reasonable to have a sanitizer that removes ALL things that are not from the standard OpenAPI spec + an API to control what elements should be sanitized, for example, via an option like:

   sanitizer:
    extensions:
     match: "x-go-*"
   

   (rly prof of concept)
4. TristanSpeakEasy commented on Sep 9, 2025

   

   TristanSpeakEasy

   on Sep 9, 2025

   Member

   More actions

   thanks for the suggestion @zdunecki I will start with something that as you says just removes anything not native to the OAS.

   And will look at adding some options for targeting specific extensions, specifying options to remove unused components etc and we can make it extensible for any future suggestions.

   Not sure I will get to it this week but will definitely add it shortly
5. TristanSpeakEasy

   added

   enhancementNew feature or requestNew feature or request

   good first issueGood for newcomersGood for newcomers

   openapiRelated to OpenAPI core functionalityRelated to OpenAPI core functionality

   on Sep 9, 2025
6. TristanSpeakEasy

   added the

   Feature

   issue type on Sep 9, 2025
7. zdunecki commented on Sep 9, 2025

   

   zdunecki

   on Sep 9, 2025

   Author

   More actions

   @TristanSpeakEasy

   Thanks a lot. If you need a contribution, I'm open.
8. TristanSpeakEasy commented on Sep 9, 2025

   

   TristanSpeakEasy

   on Sep 9, 2025

   Member

   More actions

   Feel free to have a go at implementing it. We would love contributions. You can use things like:

   • https://github.com/speakeasy-api/openapi/blob/main/openapi/clean.go
   • https://github.com/speakeasy-api/openapi/blob/main/openapi/inline.go
   • https://github.com/speakeasy-api/openapi/blob/main/openapi/optimize.go

   as examples of the underlying methods we add for the utility methods and their relevant tests

   and then see them being implemented as commands:

   • https://github.com/speakeasy-api/openapi/blob/main/openapi/cmd/clean.go
   • https://github.com/speakeasy-api/openapi/blob/main/openapi/cmd/inline.go
   • https://github.com/speakeasy-api/openapi/blob/main/openapi/cmd/optimize.go
9. TristanSpeakEasy commented on Oct 13, 2025

   

   TristanSpeakEasy

   on Oct 13, 2025

   Member

   More actions

   @zdunecki I had a go at implementing this here #59 please have a look and let me know what you think
10. TristanSpeakEasy commented on Oct 14, 2025

    

    TristanSpeakEasy

    on Oct 14, 2025

    Member

    More actions

    This feature has just been released and will be in the next build of the CLI https://github.com/speakeasy-api/openapi/releases/tag/v1.8.0
11. TristanSpeakEasy

    closed this as completedon Oct 14, 2025
12. zdunecki commented on Oct 14, 2025

    

    zdunecki

    on Oct 14, 2025

    Author

    More actions

    @TristanSpeakEasy

    Wow, thanks!

    At first glance, it looks fine, but as far as I can see, sanitization works only by excluding something, not including.

    If so, for many cases it will be harder to maintain, cuz in my case, for example, I need to sanitize it to the most common format - like supporting only a few extensions. Including will be much easier than excluding

    Best,
13. speakeasy-api

    locked and limited conversation to collaborators on Oct 14, 2025
14. TristanSpeakEasy

    converted this issue into a discussion #62 on Oct 14, 2025