chore: move docs-util to www (#7232)

* reorganize docs apps

* add README

* fix directory

* add condition for old docs

* move docs-util to www

* remove remaining docs-util

* fixes of paths

* fix scripts

* path fixes

* fix github actions

* add build packages script
This commit is contained in:
Shahed Nasser
2024-05-06 09:13:50 +03:00
committed by GitHub
parent cf9605fe6f
commit b39de05535
607 changed files with 183 additions and 254 deletions
@@ -0,0 +1,86 @@
/**
* @oas [get] /auth/{scope}/{authProvider}
* operationId: GetScopeAuthprovider
* summary: "List "
* description: Retrieve a list of in a [scope]. The can be filtered by fields
* like FILTER FIELDS. The can also be paginated.
* x-authenticated: false
* parameters:
* - name: scope
* in: path
* description: The [scope]'s scope.
* required: true
* schema:
* type: string
* - name: authProvider
* in: path
* description: The [scope]'s authprovider.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/auth/{scope}/{authProvider}'
* tags:
* - "[scope]"
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
@@ -0,0 +1,86 @@
/**
* @oas [get] /auth/{scope}/{authProvider}/callback
* operationId: GetScopeAuthproviderCallback
* summary: List Callbacks
* description: Retrieve a list of callbacks in a [scope]. The callbacks can be
* filtered by fields like FILTER FIELDS. The callbacks can also be paginated.
* x-authenticated: false
* parameters:
* - name: scope
* in: path
* description: The [scope]'s scope.
* required: true
* schema:
* type: string
* - name: authProvider
* in: path
* description: The [scope]'s authprovider.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/auth/{scope}/{authProvider}/callback'
* tags:
* - "[scope]"
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
@@ -0,0 +1,46 @@
/**
* @oas [get] /auth/{scope}/{auth_provider}
* operationId: GetScopeAuth_provider
* summary: "List "
* description: Retrieve a list of in a [scope]. The can be filtered by fields
* like FILTER FIELDS. The can also be paginated.
* x-authenticated: false
* parameters:
* - name: scope
* in: path
* description: The [scope]'s scope.
* required: true
* schema:
* type: string
* - name: auth_provider
* in: path
* description: The [scope]'s auth provider.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/auth/{scope}/{auth_provider}'
* tags:
* - "[scope]"
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
@@ -0,0 +1,46 @@
/**
* @oas [get] /auth/{scope}/{auth_provider}/callback
* operationId: GetScopeAuth_providerCallback
* summary: List Callbacks
* description: Retrieve a list of callbacks in a [scope]. The callbacks can be
* filtered by fields like FILTER FIELDS. The callbacks can also be paginated.
* x-authenticated: false
* parameters:
* - name: scope
* in: path
* description: The [scope]'s scope.
* required: true
* schema:
* type: string
* - name: auth_provider
* in: path
* description: The [scope]'s auth provider.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/auth/{scope}/{auth_provider}/callback'
* tags:
* - "[scope]"
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
@@ -0,0 +1,85 @@
/**
* @oas [post] /auth/{scope}/{authProvider}
* operationId: PostScopeAuthprovider
* summary: Add to [scope]
* description: Add a list of to a [scope].
* x-authenticated: false
* parameters:
* - name: scope
* in: path
* description: The [scope]'s scope.
* required: true
* schema:
* type: string
* - name: authProvider
* in: path
* description: The [scope]'s authprovider.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/auth/{scope}/{authProvider}'
* tags:
* - "[scope]"
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
@@ -0,0 +1,85 @@
/**
* @oas [post] /auth/{scope}/{authProvider}/callback
* operationId: PostScopeAuthproviderCallback
* summary: Add Callbacks to [scope]
* description: Add a list of callbacks to a [scope].
* x-authenticated: false
* parameters:
* - name: scope
* in: path
* description: The [scope]'s scope.
* required: true
* schema:
* type: string
* - name: authProvider
* in: path
* description: The [scope]'s authprovider.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/auth/{scope}/{authProvider}/callback'
* tags:
* - "[scope]"
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
@@ -0,0 +1,45 @@
/**
* @oas [post] /auth/{scope}/{auth_provider}
* operationId: PostScopeAuth_provider
* summary: Add to [scope]
* description: Add a list of to a [scope].
* x-authenticated: false
* parameters:
* - name: scope
* in: path
* description: The [scope]'s scope.
* required: true
* schema:
* type: string
* - name: auth_provider
* in: path
* description: The [scope]'s auth provider.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/auth/{scope}/{auth_provider}'
* tags:
* - "[scope]"
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
@@ -0,0 +1,45 @@
/**
* @oas [post] /auth/{scope}/{auth_provider}/callback
* operationId: PostScopeAuth_providerCallback
* summary: Add Callbacks to [scope]
* description: Add a list of callbacks to a [scope].
* x-authenticated: false
* parameters:
* - name: scope
* in: path
* description: The [scope]'s scope.
* required: true
* schema:
* type: string
* - name: auth_provider
* in: path
* description: The [scope]'s auth provider.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/auth/{scope}/{auth_provider}/callback'
* tags:
* - "[scope]"
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
@@ -0,0 +1,73 @@
/**
* @oas [post] /auth/session
* operationId: PostSession
* summary: Create Session
* description: Create a session.
* x-authenticated: false
* parameters:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/auth/session'
* tags:
* - Session
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/