[GitHub] [airflow] msb217 commented on a change in pull request #7549: [AIRFLOW-6929][DONT-MERGE] Add OpenAPI spec
msb217 commented on a change in pull request #7549: [AIRFLOW-6929][DONT-MERGE] Add OpenAPI spec URL: https://github.com/apache/airflow/pull/7549#discussion_r388578794 ## File path: openapi.yaml ## @@ -0,0 +1,2118 @@ +# 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 + +servers: + - url: /api/v1 +description: Airfow Stable API + +paths: + # Database entities + /connections: +get: + summary: Get all conneciton entry + 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 conneciton entry + tags: [Connection] + requestBody: +required: true +content: + application/json: +schema: + $ref: '#/components/schemas/Connection' + responses: +'200': + description: Successfull 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 connection entry + tags: [Connection] + responses: +'200': + description: Successfull 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 + tags: [Connection] + parameters: +- $ref: '#/components/parameters/UpdateMask' + requestBody: +required: true +content: + application/json: +schema: + $ref: '#/components/schemas/Connection' + + responses: +'200': + description: Successfull 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 connection entry + 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 + tags: [DAG] + parameters: +- $ref: '#/components/parameters/PageLimit' +- $ref: '#/components/parameters/PageOffset' + responses: +'200': + description: List of DAGs + content: +application/json: + schema: +allOf: + - $ref: '#/components/schemas/DAGCollection' + - $ref: '#/components/schem
[GitHub] [airflow] msb217 commented on a change in pull request #7549: [AIRFLOW-6929][DONT-MERGE] Add OpenAPI spec
msb217 commented on a change in pull request #7549: [AIRFLOW-6929][DONT-MERGE] Add OpenAPI spec URL: https://github.com/apache/airflow/pull/7549#discussion_r388578794 ## File path: openapi.yaml ## @@ -0,0 +1,2118 @@ +# 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 + +servers: + - url: /api/v1 +description: Airfow Stable API + +paths: + # Database entities + /connections: +get: + summary: Get all conneciton entry + 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 conneciton entry + tags: [Connection] + requestBody: +required: true +content: + application/json: +schema: + $ref: '#/components/schemas/Connection' + responses: +'200': + description: Successfull 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 connection entry + tags: [Connection] + responses: +'200': + description: Successfull 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 + tags: [Connection] + parameters: +- $ref: '#/components/parameters/UpdateMask' + requestBody: +required: true +content: + application/json: +schema: + $ref: '#/components/schemas/Connection' + + responses: +'200': + description: Successfull 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 connection entry + 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 + tags: [DAG] + parameters: +- $ref: '#/components/parameters/PageLimit' +- $ref: '#/components/parameters/PageOffset' + responses: +'200': + description: List of DAGs + content: +application/json: + schema: +allOf: + - $ref: '#/components/schemas/DAGCollection' + - $ref: '#/components/schem