root: remove swagger
Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
parent
b13d6deda8
commit
a51a18f3a3
|
@ -15,7 +15,7 @@ variables:
|
||||||
stages:
|
stages:
|
||||||
- stage: generate
|
- stage: generate
|
||||||
jobs:
|
jobs:
|
||||||
- job: swagger_generate
|
- job: generate_api
|
||||||
pool:
|
pool:
|
||||||
vmImage: 'ubuntu-latest'
|
vmImage: 'ubuntu-latest'
|
||||||
steps:
|
steps:
|
||||||
|
|
19149
swagger.yaml
19149
swagger.yaml
File diff suppressed because it is too large
Load diff
|
@ -9,7 +9,7 @@ trigger:
|
||||||
stages:
|
stages:
|
||||||
- stage: generate
|
- stage: generate
|
||||||
jobs:
|
jobs:
|
||||||
- job: swagger_generate
|
- job: generate_api
|
||||||
pool:
|
pool:
|
||||||
vmImage: 'ubuntu-latest'
|
vmImage: 'ubuntu-latest'
|
||||||
steps:
|
steps:
|
||||||
|
@ -23,7 +23,7 @@ stages:
|
||||||
- task: PublishPipelineArtifact@1
|
- task: PublishPipelineArtifact@1
|
||||||
inputs:
|
inputs:
|
||||||
targetPath: 'web/api/'
|
targetPath: 'web/api/'
|
||||||
artifact: 'ts_swagger_client'
|
artifact: 'ts_api_client'
|
||||||
publishLocation: 'pipeline'
|
publishLocation: 'pipeline'
|
||||||
- stage: lint
|
- stage: lint
|
||||||
jobs:
|
jobs:
|
||||||
|
@ -38,7 +38,7 @@ stages:
|
||||||
- task: DownloadPipelineArtifact@2
|
- task: DownloadPipelineArtifact@2
|
||||||
inputs:
|
inputs:
|
||||||
buildType: 'current'
|
buildType: 'current'
|
||||||
artifactName: 'ts_swagger_client'
|
artifactName: 'ts_api_client'
|
||||||
path: "web/api/"
|
path: "web/api/"
|
||||||
- task: Npm@1
|
- task: Npm@1
|
||||||
inputs:
|
inputs:
|
||||||
|
@ -60,7 +60,7 @@ stages:
|
||||||
- task: DownloadPipelineArtifact@2
|
- task: DownloadPipelineArtifact@2
|
||||||
inputs:
|
inputs:
|
||||||
buildType: 'current'
|
buildType: 'current'
|
||||||
artifactName: 'ts_swagger_client'
|
artifactName: 'ts_api_client'
|
||||||
path: "web/api/"
|
path: "web/api/"
|
||||||
- task: Npm@1
|
- task: Npm@1
|
||||||
inputs:
|
inputs:
|
||||||
|
@ -84,7 +84,7 @@ stages:
|
||||||
- task: DownloadPipelineArtifact@2
|
- task: DownloadPipelineArtifact@2
|
||||||
inputs:
|
inputs:
|
||||||
buildType: 'current'
|
buildType: 'current'
|
||||||
artifactName: 'ts_swagger_client'
|
artifactName: 'ts_api_client'
|
||||||
path: "web/api/"
|
path: "web/api/"
|
||||||
- task: Npm@1
|
- task: Npm@1
|
||||||
inputs:
|
inputs:
|
||||||
|
|
|
@ -4,7 +4,7 @@ title: API
|
||||||
|
|
||||||
Starting with 2021.3.5, every authentik instance has a built-in API browser, which can be accessed at https://authentik.company/api/v2beta/.
|
Starting with 2021.3.5, every authentik instance has a built-in API browser, which can be accessed at https://authentik.company/api/v2beta/.
|
||||||
|
|
||||||
To generate an API client, you can use the Swagger schema at https://authentik.company/api/v2beta/swagger.json.
|
To generate an API client, you can use the OpenAPI v3 schema at https://authentik.company/api/v2beta/schema/.
|
||||||
|
|
||||||
While testing, the API requests are authenticated by your browser session.
|
While testing, the API requests are authenticated by your browser session.
|
||||||
|
|
||||||
|
|
|
@ -30,7 +30,7 @@ Most functions and classes have type-hints and docstrings, so it is recommended
|
||||||
|
|
||||||
Before committing code, run `make lint` to ensure your code is formatted well. This also requires `pyright`, which can be installed with npm.
|
Before committing code, run `make lint` to ensure your code is formatted well. This also requires `pyright`, which can be installed with npm.
|
||||||
|
|
||||||
Run `make gen` to run all unittests and generated an updated swagger document for any changes you made.
|
Run `make gen` to generate an updated OpenAPI document for any changes you made.
|
||||||
|
|
||||||
## Frontend
|
## Frontend
|
||||||
|
|
||||||
|
|
|
@ -1 +0,0 @@
|
||||||
../../swagger.yaml
|
|
Reference in a new issue