Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publishing unlisted API reference #508

Open
julia-rabello opened this issue Oct 20, 2023 · 0 comments
Open

Publishing unlisted API reference #508

julia-rabello opened this issue Oct 20, 2023 · 0 comments
Assignees

Comments

@julia-rabello
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Publishing unlisted API reference is still a challenge in the current version of Developer Portal, resulting in leaving API reference from an internal repository fully unpublished and using a workaround that is not entirely appropriate for unlisted API scenarios. More details below.

Describe the solution you'd like
It would be nice to be able to publish unlisted documentation of non-public APIs from our internal repository (openapi-schemas-internal), including their overview page, as we did in the previous version of Developer Portal. This is particularly useful for alpha and closed beta products that need API reference to support testers without listing it publicly on the portal or in our public openapi-schemas repository.

Describe alternatives you've considered
The current workaround is to document APIs that should be internal on openapi-schemas and not list them on Dev Portal navigation. However, this is not ideal, because it is a public repository and the API overview page still shows up as a result on on Google Search (e.g. Profile System API which is in closed beta, see image below).

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants