Skip to content

Conversation

@jsmith
Copy link
Contributor

@jsmith jsmith commented Sep 18, 2024

Removing the OpenAPI spec to reduce possible noise with excavator PRs. This spec will eventually be added to the public docs as well which makes more sense (rather distributing it with each individual SDK).

@changelog-app
Copy link

changelog-app bot commented Sep 18, 2024

Generate changelog in changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Remove OpenAPI spec

Check the box to generate changelog(s)

  • Generate changelog entry

@tdeitch
Copy link
Contributor

tdeitch commented Sep 19, 2024

👍

@jsmith jsmith merged commit db5020f into develop Sep 19, 2024
@jsmith jsmith deleted the jacobas/remove-openapi branch January 27, 2025 23:34
@archiving-aidan
Copy link

Where can we find the openapi spec now?

@tdeitch
Copy link
Contributor

tdeitch commented Nov 17, 2025

It's available in Foundry in Developer Console:

https://www.palantir.com/docs/foundry/ontology-sdk/generate-osdk-for-other-languages/

The screenshot on that documentation page is out of date; both OSDK and Platform SDK endpoints are available now as separate specs.

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

Successfully merging this pull request may close these issues.

5 participants