Forum Discussion

chrisparton's avatar
chrisparton
New Member
3 months ago

Can a query parameter be marked as x-internal?

I have a public API endpoint with a query parameter marked as x-internal: true.

I was hoping that the query parameter would be hidden from the public API documentation, the same way that x-internal schema objects and endpoints are (see API Visibility Guidelines).

Is this supported by Stoplight, or is there another way to hide an individual query parameter on a public endpoint?

Example OpenAPI spec:

paths:
/foo:
get:
parameters:
- name: myInternalParam:
in: query
      x-internal: true
    required: false
      schema:
      type: string

Thanks!

No RepliesBe the first to reply