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

feat(openapi): support structured properties & forms #9652

Merged
merged 4 commits into from
Jan 20, 2024

Conversation

david-leifker
Copy link
Collaborator

@david-leifker david-leifker commented Jan 17, 2024

All changes refer to the DataHub OpenAPI v2 endpoints.

Strongly Typed Endpoints:

  • Forms entity & aspects

Generic Endpoints:

  • Structured Properties support
  • Experimental generic PATCH support
  • Relationships read support
  • Timeseries aspects read support

Docs:

Screenshot 2024-01-17 at 4 11 28 PM

Screenshot 2024-01-17 at 4 11 56 PM

Notes:

This typeref union prevents a strong-typed Structured Properties OpenAPI implementation. Possible fix in the future by not having to rely on the avro -> json schema transformation.

Example PATCH:

curl -X 'PATCH' -v \
  'http://localhost:8080/openapi/v2/entity/dataset/urn%3Ali%3Adataset%3A%28urn%3Ali%3AdataPlatform%3Ahive%2CSampleHiveDataset%2CPROD%29/structuredProperties' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
        "patch": [
            {
                "op": "remove",
                "path": "/properties/urn:li:structuredProperty:my.test.MyProperty01"
            }
        ],
        "arrayPrimaryKeys": {
            "properties": [
                "propertyUrn"
            ]
        }
      }' | jq

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

@github-actions github-actions bot added ingestion PR or Issue related to the ingestion of metadata docs Issues and Improvements to docs product PR or Issue related to the DataHub UI/UX devops PR or Issue related to DataHub backend & deployment smoke_test Contains changes related to smoke tests labels Jan 17, 2024
@david-leifker david-leifker changed the base branch from master to feat-structured-properties January 17, 2024 21:47
All changes refer to the DataHub OpenAPI v2 endpoints.

Strongly Typed Endpoints:
* Forms entity & aspects

Generic Endpoints:
* Structured Properties support
* Experimental generic PATCH support
* Relationships read support
* Timeseries aspects read support

Docs:
* Structured Properties OpenAPI v2 Guide
@david-leifker david-leifker merged commit 7ab7b28 into feat-structured-properties Jan 20, 2024
57 checks passed
@david-leifker david-leifker deleted the openapi-feat-v3 branch January 20, 2024 05:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops PR or Issue related to DataHub backend & deployment docs Issues and Improvements to docs ingestion PR or Issue related to the ingestion of metadata product PR or Issue related to the DataHub UI/UX smoke_test Contains changes related to smoke tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants