Skip to content

Support excluding endpoints #72

Closed
Closed

Description

@mortocks

Add ability to exclude collections or endpoints from the spec including

  • payload preferences
  • payload migrations
  • custom collections
  • custom endpoints

Activity

  1. AngelliaX commented on Dec 31, 2025

    @AngelliaX

    add it yourself man, then make a PR for us

  2. janbaykara commented on Jan 24, 2026

    @janbaykara

    I have achieved this through a local patch of the package. Feel free to take that and turn it into a PR: gameworkersolidarity/website@ebfb009

  3. janbuchar commented on Sep 18, 2026

    @janbuchar
    Owner

    Shipped in 0.3.0 as the filters option (#75):

    openapi({
      metadata: { title: 'My API', version: '1.0' },
      filters: {
        hideInternalCollections: true,
        excludeCollections: ['someCollection'],
        excludeGlobals: ['footer'],
      },
    })
    • hideInternalCollections drops every payload-* collection, which covers preferences and migrations
    • excludeCollections / excludeGlobals (and the include* counterparts) cover your own
    • custom endpoints are opt-in since feat: Add custom endpoints #53 — they only show up if you attach custom.openapi to them, so there is nothing to exclude

    This is slug-granular. Hiding one operation on a collection you otherwise want is #30.

    Thanks @janbaykara, your patch is close to what landed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions