[GitHub] [airflow] kaxil commented on a change in pull request #8721: Add OpenAPI specification (II)
kaxil commented on a change in pull request #8721: URL: https://github.com/apache/airflow/pull/8721#discussion_r431046930 ## File path: openapi.yaml ## @@ -0,0 +1,2427 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +--- +openapi: 3.0.3 + +info: + title: "Airflow API (Stable)" + description: Apache Airflow management API. + version: '1.0.0' + license: +name: Apache 2.0 +url: http://www.apache.org/licenses/LICENSE-2.0.html + contact: +name: Apache Foundation Review comment: ```suggestion name: Apache Software Foundation ``` Although maybe we should change it to Airflow PMC & Committers or something, I am not sure This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [airflow] kaxil commented on a change in pull request #8721: Add OpenAPI specification (II)
kaxil commented on a change in pull request #8721:
URL: https://github.com/apache/airflow/pull/8721#discussion_r430988478
##
File path: openapi.yaml
##
@@ -0,0 +1,2411 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+---
+openapi: 3.0.3
+
+info:
+ title: "Airflow API (Stable)"
+ description: Apache Airflow management API.
+ version: '1.0.0'
+ license:
+name: Apache 2.0
+url: http://www.apache.org/licenses/LICENSE-2.0.html
+ contact:
+name: Apache Foundation
+url: https://airflow.apache.org
+email: d...@airflow.apache.org
+
+servers:
+ - url: /api/v1
+description: Airfow Stable API.
+
+paths:
+ # Database entities
+ /connections:
+get:
+ summary: Get all connection entries
+ operationId: getConnections
+ tags: [Connection]
+ parameters:
+- $ref: '#/components/parameters/PageLimit'
+- $ref: '#/components/parameters/PageOffset'
+ responses:
+'200':
+ description: List of connection entry.
+ content:
+application/json:
+ schema:
+allOf:
+ - $ref: '#/components/schemas/ConnectionCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+
+post:
+ summary: Create connection entry
+ operationId: createConnection
+ tags: [Connection]
+ requestBody:
+required: true
+content:
+ application/json:
+schema:
+ $ref: '#/components/schemas/Connection'
+ responses:
+'200':
+ description: Successful response.
+ content:
+application/json:
+ schema:
+$ref: '#/components/schemas/Connection'
+'400':
+ $ref: '#/components/responses/BadRequest'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /connections/{connection_id}:
+parameters:
+ - $ref: '#/components/parameters/ConnectionID'
+
+get:
+ summary: Get a connection entry
+ operationId: getConnection
+ tags: [Connection]
+ responses:
+'200':
+ description: Successful response.
+ content:
+application/json:
+ schema:
+$ref: '#/components/schemas/Connection'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+'404':
+ $ref: '#/components/responses/NotFound'
+
+patch:
+ summary: Update a connection entry
+ operationId: updaateConnection
+ tags: [Connection]
+ parameters:
+- $ref: '#/components/parameters/UpdateMask'
+ requestBody:
+required: true
+content:
+ application/json:
+schema:
+ $ref: '#/components/schemas/Connection'
+
+ responses:
+'200':
+ description: Successful response.
+ content:
+application/json:
+ schema:
+$ref: '#/components/schemas/Connection'
+'400':
+ $ref: '#/components/responses/BadRequest'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+'404':
+ $ref: '#/components/responses/NotFound'
+
+delete:
+ summary: Delete a connection entry
+ operationId: deleteConnection
+ tags: [Connection]
+ responses:
+'204':
+ description: No content.
+'400':
+ $ref: '#/components/responses/BadRequest'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /dags:
+get:
+ summary: Get all DAGs
+ operationId: getDags
+ tags: [DAG]
+ parameters:
+- $ref: '#/components/parameters/PageLimit'
+- $ref: '#/components/parameters/PageOffset'
+
[GitHub] [airflow] kaxil commented on a change in pull request #8721: Add OpenAPI specification (II)
kaxil commented on a change in pull request #8721:
URL: https://github.com/apache/airflow/pull/8721#discussion_r430985695
##
File path: openapi.yaml
##
@@ -0,0 +1,2411 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+---
+openapi: 3.0.3
+
+info:
+ title: "Airflow API (Stable)"
+ description: Apache Airflow management API.
+ version: '1.0.0'
+ license:
+name: Apache 2.0
+url: http://www.apache.org/licenses/LICENSE-2.0.html
+ contact:
+name: Apache Foundation
+url: https://airflow.apache.org
+email: d...@airflow.apache.org
+
+servers:
+ - url: /api/v1
+description: Airfow Stable API.
+
+paths:
+ # Database entities
+ /connections:
+get:
+ summary: Get all connection entries
+ operationId: getConnections
+ tags: [Connection]
+ parameters:
+- $ref: '#/components/parameters/PageLimit'
+- $ref: '#/components/parameters/PageOffset'
+ responses:
+'200':
+ description: List of connection entry.
+ content:
+application/json:
+ schema:
+allOf:
+ - $ref: '#/components/schemas/ConnectionCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+
+post:
+ summary: Create connection entry
+ operationId: createConnection
+ tags: [Connection]
+ requestBody:
+required: true
+content:
+ application/json:
+schema:
+ $ref: '#/components/schemas/Connection'
+ responses:
+'200':
+ description: Successful response.
+ content:
+application/json:
+ schema:
+$ref: '#/components/schemas/Connection'
+'400':
+ $ref: '#/components/responses/BadRequest'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /connections/{connection_id}:
+parameters:
+ - $ref: '#/components/parameters/ConnectionID'
+
+get:
+ summary: Get a connection entry
+ operationId: getConnection
+ tags: [Connection]
+ responses:
+'200':
+ description: Successful response.
+ content:
+application/json:
+ schema:
+$ref: '#/components/schemas/Connection'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+'404':
+ $ref: '#/components/responses/NotFound'
+
+patch:
+ summary: Update a connection entry
+ operationId: updaateConnection
+ tags: [Connection]
+ parameters:
+- $ref: '#/components/parameters/UpdateMask'
+ requestBody:
+required: true
+content:
+ application/json:
+schema:
+ $ref: '#/components/schemas/Connection'
+
+ responses:
+'200':
+ description: Successful response.
+ content:
+application/json:
+ schema:
+$ref: '#/components/schemas/Connection'
+'400':
+ $ref: '#/components/responses/BadRequest'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+'404':
+ $ref: '#/components/responses/NotFound'
+
+delete:
+ summary: Delete a connection entry
+ operationId: deleteConnection
+ tags: [Connection]
+ responses:
+'204':
+ description: No content.
+'400':
+ $ref: '#/components/responses/BadRequest'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /dags:
+get:
+ summary: Get all DAGs
+ operationId: getDags
+ tags: [DAG]
+ parameters:
+- $ref: '#/components/parameters/PageLimit'
+- $ref: '#/components/parameters/PageOffset'
+
[GitHub] [airflow] kaxil commented on a change in pull request #8721: Add OpenAPI specification (II)
kaxil commented on a change in pull request #8721:
URL: https://github.com/apache/airflow/pull/8721#discussion_r430086222
##
File path: openapi.yaml
##
@@ -0,0 +1,2411 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+---
+openapi: 3.0.3
+
+info:
+ title: "Airflow API (Stable)"
+ description: Apache Airflow management API.
+ version: '1.0.0'
+ license:
+name: Apache 2.0
+url: http://www.apache.org/licenses/LICENSE-2.0.html
+ contact:
+name: Apache Foundation
+url: https://airflow.apache.org
+email: d...@airflow.apache.org
+
+servers:
+ - url: /api/v1
+description: Airfow Stable API.
+
+paths:
+ # Database entities
+ /connections:
+get:
+ summary: Get all connection entries
+ operationId: getConnections
+ tags: [Connection]
+ parameters:
+- $ref: '#/components/parameters/PageLimit'
+- $ref: '#/components/parameters/PageOffset'
+ responses:
+'200':
+ description: List of connection entry.
+ content:
+application/json:
+ schema:
+allOf:
+ - $ref: '#/components/schemas/ConnectionCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+
+post:
+ summary: Create connection entry
+ operationId: createConnection
+ tags: [Connection]
+ requestBody:
+required: true
+content:
+ application/json:
+schema:
+ $ref: '#/components/schemas/Connection'
+ responses:
+'200':
+ description: Successful response.
+ content:
+application/json:
+ schema:
+$ref: '#/components/schemas/Connection'
+'400':
+ $ref: '#/components/responses/BadRequest'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /connections/{connection_id}:
+parameters:
+ - $ref: '#/components/parameters/ConnectionID'
+
+get:
+ summary: Get a connection entry
+ operationId: getConnection
+ tags: [Connection]
+ responses:
+'200':
+ description: Successful response.
+ content:
+application/json:
+ schema:
+$ref: '#/components/schemas/Connection'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+'404':
+ $ref: '#/components/responses/NotFound'
+
+patch:
+ summary: Update a connection entry
+ operationId: updaateConnection
+ tags: [Connection]
+ parameters:
+- $ref: '#/components/parameters/UpdateMask'
+ requestBody:
+required: true
+content:
+ application/json:
+schema:
+ $ref: '#/components/schemas/Connection'
+
+ responses:
+'200':
+ description: Successful response.
+ content:
+application/json:
+ schema:
+$ref: '#/components/schemas/Connection'
+'400':
+ $ref: '#/components/responses/BadRequest'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+'404':
+ $ref: '#/components/responses/NotFound'
+
+delete:
+ summary: Delete a connection entry
+ operationId: deleteConnection
+ tags: [Connection]
+ responses:
+'204':
+ description: No content.
+'400':
+ $ref: '#/components/responses/BadRequest'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /dags:
+get:
+ summary: Get all DAGs
+ operationId: getDags
+ tags: [DAG]
+ parameters:
+- $ref: '#/components/parameters/PageLimit'
+- $ref: '#/components/parameters/PageOffset'
+
[GitHub] [airflow] kaxil commented on a change in pull request #8721: Add OpenAPI specification (II)
kaxil commented on a change in pull request #8721:
URL: https://github.com/apache/airflow/pull/8721#discussion_r427870779
##
File path: openapi.yaml
##
@@ -0,0 +1,2411 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+---
+openapi: 3.0.3
+
+info:
+ title: "Airflow API (Stable)"
+ description: Apache Airflow management API.
+ version: '1.0.0'
+ license:
+name: Apache 2.0
+url: http://www.apache.org/licenses/LICENSE-2.0.html
+ contact:
+name: Apache Foundation
+url: https://airflow.apache.org
+email: d...@airflow.apache.org
+
+servers:
+ - url: /api/v1
+description: Airfow Stable API.
+
+paths:
+ # Database entities
+ /connections:
+get:
+ summary: Get all connection entries
+ operationId: getConnections
+ tags: [Connection]
+ parameters:
+- $ref: '#/components/parameters/PageLimit'
+- $ref: '#/components/parameters/PageOffset'
+ responses:
+'200':
+ description: List of connection entry.
+ content:
+application/json:
+ schema:
+allOf:
+ - $ref: '#/components/schemas/ConnectionCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+
+post:
+ summary: Create connection entry
+ operationId: createConnection
+ tags: [Connection]
+ requestBody:
+required: true
+content:
+ application/json:
+schema:
+ $ref: '#/components/schemas/Connection'
+ responses:
+'200':
+ description: Successful response.
+ content:
+application/json:
+ schema:
+$ref: '#/components/schemas/Connection'
+'400':
+ $ref: '#/components/responses/BadRequest'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /connections/{connection_id}:
+parameters:
+ - $ref: '#/components/parameters/ConnectionID'
+
+get:
+ summary: Get a connection entry
+ operationId: getConnection
+ tags: [Connection]
+ responses:
+'200':
+ description: Successful response.
+ content:
+application/json:
+ schema:
+$ref: '#/components/schemas/Connection'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+'404':
+ $ref: '#/components/responses/NotFound'
+
+patch:
+ summary: Update a connection entry
+ operationId: updaateConnection
+ tags: [Connection]
+ parameters:
+- $ref: '#/components/parameters/UpdateMask'
+ requestBody:
+required: true
+content:
+ application/json:
+schema:
+ $ref: '#/components/schemas/Connection'
+
+ responses:
+'200':
+ description: Successful response.
+ content:
+application/json:
+ schema:
+$ref: '#/components/schemas/Connection'
+'400':
+ $ref: '#/components/responses/BadRequest'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+'404':
+ $ref: '#/components/responses/NotFound'
+
+delete:
+ summary: Delete a connection entry
+ operationId: deleteConnection
+ tags: [Connection]
+ responses:
+'204':
+ description: No content.
+'400':
+ $ref: '#/components/responses/BadRequest'
+'401':
+ $ref: '#/components/responses/Unauthenticated'
+'403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /dags:
+get:
+ summary: Get all DAGs
+ operationId: getDags
+ tags: [DAG]
+ parameters:
+- $ref: '#/components/parameters/PageLimit'
+- $ref: '#/components/parameters/PageOffset'
+
