Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 138 additions & 0 deletions providers/src/supabase/v00.00.00000/provider.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
id: supabase
name: supabase
version: v00.00.00000
providerServices:
advisors:
id: advisors:v00.00.00000
name: advisors
preferred: true
service:
$ref: supabase/v00.00.00000/services/advisors.yaml
title: advisors API
version: v00.00.00000
description: Advisors related endpoints
analytics:
id: analytics:v00.00.00000
name: analytics
preferred: true
service:
$ref: supabase/v00.00.00000/services/analytics.yaml
title: analytics API
version: v00.00.00000
description: Analytics related endpoints
billing:
id: billing:v00.00.00000
name: billing
preferred: true
service:
$ref: supabase/v00.00.00000/services/billing.yaml
title: billing API
version: v00.00.00000
description: Billing related endpoints
branches:
id: branches:v00.00.00000
name: branches
preferred: true
service:
$ref: supabase/v00.00.00000/services/branches.yaml
title: branches API
version: v00.00.00000
description: supabase branches API
config:
id: config:v00.00.00000
name: config
preferred: true
service:
$ref: supabase/v00.00.00000/services/config.yaml
title: config API
version: v00.00.00000
description: supabase config API
database:
id: database:v00.00.00000
name: database
preferred: true
service:
$ref: supabase/v00.00.00000/services/database.yaml
title: database API
version: v00.00.00000
description: Database related endpoints
domains:
id: domains:v00.00.00000
name: domains
preferred: true
service:
$ref: supabase/v00.00.00000/services/domains.yaml
title: domains API
version: v00.00.00000
description: Domains related endpoints
functions:
id: functions:v00.00.00000
name: functions
preferred: true
service:
$ref: supabase/v00.00.00000/services/functions.yaml
title: functions API
version: v00.00.00000
description: supabase functions API
network:
id: network:v00.00.00000
name: network
preferred: true
service:
$ref: supabase/v00.00.00000/services/network.yaml
title: network API
version: v00.00.00000
description: supabase network API
organizations:
id: organizations:v00.00.00000
name: organizations
preferred: true
service:
$ref: supabase/v00.00.00000/services/organizations.yaml
title: organizations API
version: v00.00.00000
description: Organizations related endpoints
profile:
id: profile:v00.00.00000
name: profile
preferred: true
service:
$ref: supabase/v00.00.00000/services/profile.yaml
title: profile API
version: v00.00.00000
description: supabase profile API
projects:
id: projects:v00.00.00000
name: projects
preferred: true
service:
$ref: supabase/v00.00.00000/services/projects.yaml
title: projects API
version: v00.00.00000
description: Projects related endpoints
secrets:
id: secrets:v00.00.00000
name: secrets
preferred: true
service:
$ref: supabase/v00.00.00000/services/secrets.yaml
title: secrets API
version: v00.00.00000
description: Secrets related endpoints
storage:
id: storage:v00.00.00000
name: storage
preferred: true
service:
$ref: supabase/v00.00.00000/services/storage.yaml
title: storage API
version: v00.00.00000
description: >-
Visit
[https://supabase.github.io/storage/](https://supabase.github.io/storage/)
for complete documentation.
config:
auth:
type: bearer
credentialsenvvar: SUPABASE_ACCESS_TOKEN
snake_case_aliases: true
249 changes: 249 additions & 0 deletions providers/src/supabase/v00.00.00000/services/advisors.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,249 @@
openapi: 3.0.0
info:
title: advisors API
description: Advisors related endpoints
version: 1.0.0
paths:
/advisors/performance:
get:
deprecated: true
description: This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
operationId: v1-get-performance-advisors
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V1ProjectAdvisorsResponse'
'401':
description: Unauthorized
'403':
description: Forbidden action
'429':
description: Rate limit exceeded
security:
- bearer: []
summary: Gets project performance advisors.
tags:
- Advisors
x-badges:
- name: 'OAuth scope: database:read'
position: after
x-endpoint-owners:
- control-plane
x-fga-permissions:
- - advisors_read
x-oauth-scope: database:read
/advisors/security:
get:
deprecated: true
description: This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
operationId: v1-get-security-advisors
parameters:
- name: lint_type
required: false
in: query
schema:
example: sql
type: string
enum:
- sql
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V1ProjectAdvisorsResponse'
'401':
description: Unauthorized
'403':
description: Forbidden action
'429':
description: Rate limit exceeded
security:
- bearer: []
summary: Gets project security advisors.
tags:
- Advisors
x-badges:
- name: 'OAuth scope: database:read'
position: after
x-endpoint-owners:
- control-plane
x-fga-permissions:
- - advisors_read
x-oauth-scope: database:read
components:
schemas:
V1ProjectAdvisorsResponse:
type: object
properties:
lints:
type: array
items:
type: object
properties:
name:
enum:
- unindexed_foreign_keys
- auth_users_exposed
- auth_rls_initplan
- no_primary_key
- unused_index
- multiple_permissive_policies
- policy_exists_rls_disabled
- rls_enabled_no_policy
- duplicate_index
- security_definer_view
- function_search_path_mutable
- rls_disabled_in_public
- extension_in_public
- rls_references_user_metadata
- materialized_view_in_api
- foreign_table_in_api
- unsupported_reg_types
- auth_otp_long_expiry
- auth_otp_short_length
- ssl_not_enforced
- log_connections_not_enabled
- network_restrictions_not_set
- password_requirements_min_length
- pitr_not_enabled
- auth_leaked_password_protection
- auth_insufficient_mfa_options
- auth_password_policy_missing
- leaked_service_key
- no_backup_admin
- vulnerable_postgres_version
- db_not_reachable
- db_connection_failing
- db_connection_limit_reached
- instance_telemetry_lost
- instance_db_down
- instance_alert_firing
- log_service_error_rate_high
- project_not_active
- advisor_check_unavailable
type: string
title:
type: string
level:
type: string
enum:
- ERROR
- WARN
- INFO
facing:
type: string
enum:
- EXTERNAL
categories:
type: array
items:
type: string
enum:
- PERFORMANCE
- SECURITY
- HEALTH
x-ignore-array-items-must-be-objects: true
description:
type: string
detail:
type: string
remediation:
type: string
metadata:
type: object
properties:
schema:
type: string
name:
type: string
entity:
type: string
type:
enum:
- table
- view
- materialized view
- foreign table
- auth
- function
- extension
- compliance
- health
type: string
fkey_name:
type: string
fkey_columns:
x-ignore-array-items-must-be-objects: true
type: array
items:
type: number
cache_key:
type: string
observed_at:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
required:
- name
- title
- level
- facing
- categories
- description
- detail
- remediation
- cache_key
additionalProperties: {}
required:
- lints
x-stackQL-resources:
performance_lints:
id: supabase.advisors.performance_lints
name: performance_lints
title: Performance Lints
methods:
list:
operation:
$ref: '#/paths/~1advisors~1performance/get'
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.lints
sqlVerbs:
select:
- $ref: '#/components/x-stackQL-resources/performance_lints/methods/list'
insert: []
update: []
delete: []
replace: []
security_lints:
id: supabase.advisors.security_lints
name: security_lints
title: Security Lints
methods:
list:
operation:
$ref: '#/paths/~1advisors~1security/get'
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.lints
sqlVerbs:
select:
- $ref: '#/components/x-stackQL-resources/security_lints/methods/list'
insert: []
update: []
delete: []
replace: []
servers:
- url: https://api.supabase.com/v1/projects/{ref}
variables:
ref:
description: Supabase project reference (the Project ID shown in the dashboard under Settings -> General; 20 lowercase letters). Resolved from the SUPABASE_PROJECT_ID environment variable when it is set (x-stackQL-envVar); otherwise it must be supplied on every project-scoped query as WHERE ref = '<ref>'. A WHERE value always takes precedence over the environment.
x-stackQL-envVar: SUPABASE_PROJECT_ID
Loading
Loading