Metadata Adapters Endpoints¶

Metadata Adapters API endpoints.

Overview¶

Method	Endpoint	Description
GET	`/api/v1/metadata-adapters/`	List Visible Metadata Adapters
GET	`/api/v1/metadata-adapters/template-wildcards`	List Template Wildcards
PUT	`/api/v1/metadata-adapters/{code}/visibility`	Update Metadata Adapter Visibility

API Reference¶

Sartiq Backend Server - Metadata Adapters 0.1.0¶

metadata-adapters¶

GET /api/v1/metadata-adapters/template-wildcards¶

List Template Wildcards

Description

Return every wildcard available inside naming_convention_template.

Static across deployments, derived from the in-process registry.

Responses

200 OK

application/json

[
    {
        "name": "string",
        "description": "string",
        "example": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "items": {
        "$ref": "#/components/schemas/TemplateWildcardPublic"
    },
    "type": "array",
    "title": "Response List Template Wildcards"
}

GET /api/v1/metadata-adapters/¶

List Visible Metadata Adapters

Description

Adapters the caller is allowed to pick when configuring exports.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`organization_id`	query			No

Responses

200 OK422 Unprocessable Entity

application/json

[
    {
        "code": "default",
        "display_name": "string",
        "naming_convention_example": "string",
        "is_customizable": true,
        "is_public": true,
        "organization_ids": [
            "205cae6c-22c7-4dec-957f-c8d4dadf5b8b"
        ]
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/MetadataAdapterPublic"
    },
    "title": "Response List Visible Metadata Adapters"
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

PUT /api/v1/metadata-adapters/{code}/visibility¶

Update Metadata Adapter Visibility

Description

Replace visibility settings for one adapter. Admin only.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`code`	path	string		No

Request body

application/json

{
    "is_public": true,
    "organization_ids": [
        "85030aa7-6be7-4219-b6e3-6d610f7fa8c5"
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "is_public": {
            "type": "boolean",
            "title": "Is Public"
        },
        "organization_ids": {
            "items": {
                "type": "string",
                "format": "uuid"
            },
            "type": "array",
            "title": "Organization Ids",
            "default": []
        }
    },
    "type": "object",
    "required": [
        "is_public"
    ],
    "title": "AdapterVisibilityUpdate",
    "description": "Replacement payload for one adapter's visibility settings."
}

Responses

200 OK422 Unprocessable Entity

application/json

{
    "is_public": true,
    "organization_ids": [
        "1de98edb-68e0-4623-b4c2-2e9d1a3c90eb"
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "is_public": {
            "type": "boolean",
            "title": "Is Public"
        },
        "organization_ids": {
            "items": {
                "type": "string",
                "format": "uuid"
            },
            "type": "array",
            "title": "Organization Ids",
            "default": []
        }
    },
    "type": "object",
    "required": [
        "is_public"
    ],
    "title": "AdapterVisibilityUpdate",
    "description": "Replacement payload for one adapter's visibility settings."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Schemas¶

AdapterVisibilityUpdate¶

Name	Type	Description
`is_public`	boolean
`organization_ids`	Array<string(uuid)>

HTTPValidationError¶

Name	Type	Description
`detail`	Array<ValidationError>

MetadataAdapter¶

Type: string

MetadataAdapterPublic¶

Name	Type	Description
`code`	MetadataAdapter
`display_name`	string
`is_customizable`	boolean
`is_public`	boolean
`naming_convention_example`	string
`organization_ids`	Array<string(uuid)>

TemplateWildcardPublic¶

Name	Type	Description
`description`	string
`example`	string
`name`	string

ValidationError¶

Name	Type	Description
`ctx`
`input`
`loc`	Array<>
`msg`	string
`type`	string

Security schemes¶

Name	Type	Scheme	Description
OAuth2PasswordBearer	oauth2