Skip to content

[#982] doc(OAS): add OAS for RESTful APIs of Metalake#1010

Merged
jerryshao merged 1 commit intoapache:mainfrom
mchades:issue-982
Dec 7, 2023
Merged

[#982] doc(OAS): add OAS for RESTful APIs of Metalake#1010
jerryshao merged 1 commit intoapache:mainfrom
mchades:issue-982

Conversation

@mchades
Copy link
Contributor

@mchades mchades commented Dec 7, 2023

What changes were proposed in this pull request?

To introduce OAS, I adapt OAS for RESTful APIs of Metalake first

Why are the changes needed?

Fix: #982

Does this PR introduce any user-facing change?

no

How was this patch tested?

just docs

paths:
/metalakes:
# escape the path name by replacing `/` with `~1`
$ref: "./metalakes.yaml#/paths/~1metalakes"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the usage of "~1"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the comment above says this is used to escape /, here escape /metalakes to ~1metalakes

# todo: add OAuth2 security schema
BearerAuth:
type: http
scheme: bearer
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@qqqttt123 Can you sync with @mchades with the oauth part here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Track this by #1015

@jerryshao jerryshao merged commit b252c86 into apache:main Dec 7, 2023
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.

[Subtask] Introduce the OAS for managing REST APIs

2 participants